3 ms·
I've tried probably half a dozen times to learn how to generate simple sphinx docs for my side projects. I start reading tutorials, then half a weekend goes by,
by diafygi 10y ago
I've tried probably half a dozen times to learn how to generate simple sphinx docs for my side projects. I start reading tutorials, then half a weekend goes by, and I give up because I'm knee deep in templates and rst. Either I'm reading the wrong tutorials or the learning curve for sphinx is much higher than you assume. Where are the tutorials that make it as simple as you say? All I want is something like:
pip install sphinx
sphinx autogen_html_docs --output /path/to/folder --input /path/to/mymodule_folder
- JelteF 10y agoSphinx really isn't that hard. The default config file is just quite crappy. Check out this one for one of my projects: https://github.com/JelteF/easyfuse/blob/master/docs/conf.py https://github.com/JelteF/easyfuse/blob/master/docs/conf.py Especially this line is quite important so you can put python references between backticks and they will automatically be interlinked: default_role = 'py:obj' This file is also quite useful: https://github.com/JelteF/easyfuse/blob/master/docs/create_doc_files.sh https://github.com/JelteF/easyfuse/blob/master/docs/create_d...
- pekk 10y agoSphinx's own documentation makes it vastly easier than `sphinx autogen_html_docs --output /path/to/folder --input /path/to/mymodule_folder` which reads like a really complicated command line of uncertain meaning.