https://github.com/raybellwaves/myfavdocs
My opinionated favourite (yes that u is left in favourite intentially) docs
https://github.com/raybellwaves/myfavdocs
Last synced: about 2 months ago
JSON representation
My opinionated favourite (yes that u is left in favourite intentially) docs
- Host: GitHub
- URL: https://github.com/raybellwaves/myfavdocs
- Owner: raybellwaves
- Created: 2024-04-17T18:55:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-04T17:37:05.000Z (about 1 year ago)
- Last Synced: 2025-02-01T11:41:30.545Z (4 months ago)
- Language: Shell
- Homepage: https://raybellwaves.github.io/myfavdocs/
- Size: 13.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# myfavdocs
My opinionated favourite (yes that u is left in favourite intentially) docs.
Hosted at https://raybellwaves.github.io/myfavdocs/.
The code to generate the files is `make_files.sh` and is designed to run on a Mac.
This came about when starting with https://www.sphinx-doc.org/en/master/tutorial/getting-started.html and https://www.sphinx-doc.org/en/master/development/tutorials/index.html and building upon them.
What I like and why:
- xarray (https://docs.xarray.dev/en/stable/) has my favorite docs but I may be biased. I made decisions here based in their configuration.
- Using `sphinx.ext.napoleon` over `numpydoc` as it gives hyperlinks of types in the Parameters and Return. I also like the bullet points that it uses for Parameters.
- Using `pydata_sphinx_theme` for the html theme.
- In my case I left `autodoc_typehints` as the default. You can set it to `None` if you have types that get pretty long e.g. `Optional[dict[str | int, list[int | str], float]]...`