Elektrine lite

← Feed

@AstroLightz@lemmy.world

[Python] Question for People Familiar with Sphinx Documentation

2026-05-13 01:37 UTC

cross-posted from: lemmy.world/post/46764460 Question for People Familiar with Sphinx Documentation So, I’m making documentation for my project using Sphinx with hatch/hatchling. I’m currently using the sphinx-rtd-theme as my theme. I already make a quickstart page for my project, but the src directory page is included in the sidebar. I would like to rename it to “Source Files”, but when changing the header in my modules.rst file, it gets reset each time I build. The main extensions I’m using for Sphinx are ‘sphinx.ext.todo’, ‘sphinx.ext.viewcode’, and ‘sphinx.ext.autodoc’. For context, my project structure looks something like this: my_project/ | ---- requirements.txt | ---- README.md | ---- src/ | -------- my_project_module/ | -------------- __init__.py | -------------- foo.py | -------------- bar.py | -------- docs/ | -------------- requirements.txt | -------------- requirements.in | -------------- conf.py | -------------- modules.rst | -------------- index.rst | -------------- quickstart.rst | -------------- my_project_module.rst | -------------- _static/ | ------------------ some_img.png Is there a way to change the display name of my src directory without renaming the actual directory in my project? Also, is there a way to reorder the list so my quickstart guide shows up above the source page?

Replies (0)

No replies.