-
Notifications
You must be signed in to change notification settings - Fork 899
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Modernise the conf.py file #1362
Conversation
This builds upon #1361 (it's what motivated me filing that PR) so I'll keep this as a draft until that one is resolved. |
8606af4
to
adafd9b
Compare
This follows the style of the Sphinx 5+ configuration file template, removing commented out sections and content duplicated from the documentation. This also removes a few unused values and uses the newer `root_doc` name.
This raises a SyntaxWarning on new-enough Python versions.
adafd9b
to
328b812
Compare
This makes the homepage accessible via the sidebar.
This is good to go, and only need a review from another editor. :) |
BTW, could we somehow allow the footer to hold the donations link and license (via template)? |
Let's leave that for a separate PR? |
I don't know. 😅 |
Yes, I'll have a look now. |
@pradyunsg Umm, unsure if you could arrange yourself with the idea of.... two footers? |
I'm not sure what you're suggesting here. 😅 |
@pradyunsg I've created a Sphinx template based on your Furo HTML classes, unfortunately the only way I've found to do this implies having a second footer below the standard one. Or would you prefer extending your page.html layout, including an option for conf.py to add custom text? |
For anyone curious about what keys have changed in this PR, you can use
python -i source/conf.py
followed bylocals()
to capture the assignments made.Based on that, below is the diff between
{str(k): str(v) for k,v in locals()}
with the old conf.py (i.e. main) and new conf.py (i.e. this PR).The keys removed were set to values that influenced ~no relevant part of the build output.