issues
search
madetech
/
data-101
MIT License
12
stars
9
forks
source link
Add Sphinx guide
#56
Closed
luke-a-williams
closed
6 months ago
luke-a-williams
commented
6 months ago
Guide outcomes - the PR should cover the following content
What Sphinx even is
To understand potential use cases of this setup, as docstrings aren't for everyone!
Launch a local Sphinx documentation server that dynamically updates in real time
Sphinx configuration understands markdown, and all documentation files exist as markdown and not ReStructuredText.
Sphinx configuration allows dynamic reading of Docstrings, of Google or Numpy standard format.
How to handle Sphinx within version control.
Local configuration is ready for potential deployment into CI/CD pipelines with proper routing.
Demonstrate how to interact with the configuration to change the theme, and use extensions.
Guide outcomes - the PR should cover the following content