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?
One of my main projects (
framed_text) is pretty much complete and now has entered maintenance mode, where I'll mainly fix bugs and only add something if I need it.However, I've started work on a Logging Python package that allows for full customization of the log text (How its structured), whether to log it to the console, a file, or both. Plus a timer for timing code execution (TBD).
Mainly making it for my sake, but I'll upload it anyway in case someone else wants to use it. (That's basically my programming philosophy)