5

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?

you are viewing a single comment's thread
view the rest of the comments
[-] logging_strict@programming.dev 1 points 2 weeks ago* (last edited 2 weeks ago)

Life is too short for ‘sphinx.ext.todo’. It's overrated. Won't have enough hours in the day to hunt within in-code documentation for explanation of things you need to do.

Your todo list should be in ur CHANGES.rst file. Won't be building the docs just to see todo list.

Also the moment you have an idea, you immediately write it into CHANGES.rst. Don't wait even one second. Absolutely immediately or as soon as you get home, first thing! Write your idea first, no reading your other ideas. It'll distract you and might cause you to forget.

Don't even think of making any code changes without writing the idea down first.

this post was submitted on 12 May 2026
5 points (100.0% liked)

Python

7932 readers
17 users here now

Welcome to the Python community on the programming.dev Lemmy instance!

📅 Events

PastNovember 2023

October 2023

July 2023

August 2023

September 2023

🐍 Python project:
💓 Python Community:
✨ Python Ecosystem:
🌌 Fediverse
Communities
Projects
Feeds

founded 3 years ago
MODERATORS