https://github.com/davidjnevin/sphinx-md-setup
A deeper look at the functionalities of Sphinx Documentation system
https://github.com/davidjnevin/sphinx-md-setup
Last synced: 3 months ago
JSON representation
A deeper look at the functionalities of Sphinx Documentation system
- Host: GitHub
- URL: https://github.com/davidjnevin/sphinx-md-setup
- Owner: davidjnevin
- Created: 2022-11-03T18:47:12.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-11T13:59:38.000Z (over 2 years ago)
- Last Synced: 2024-12-31T02:24:21.284Z (5 months ago)
- Language: Python
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sphinx Template
A Sphinx setup built for insertion into projects.
Features included:
- Runs in `markdown` not `reStructuredText`
- Project title -> HTML title
- Page front matter title -> HTML page title.
- Text snippets replacements in seperate `.py`
- Active todolist from code base comments
- Google docstring ready
- Using [Furo](https://pradyunsg.me/furo) theme
*Requirements.txt* contains the pip requirements.
## To install
[Install Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
Clone the repo.
Run pip -r requirements.txt
Delete `empty.txt' from "_static" folder.
Should be good to go.