maint: Restructure docs configuration file and improve docs pages #3615
Conversation
| # The file above was generated using sphinx 8.1.3 with this command: | ||
| # sphinx-quickstart --project "mamba" --author "QuantStack & mamba contributors" -v "latest" -r "latest" -l en --no-sep --no-makefile --no-batchfile | ||
| # These are custom options for this project |
There was a problem hiding this comment.
This allows to have really simple configuration file for understanding, where you can easily see, which part of the docs is the standard config, and which is custom for this project.
Updating to new sphinx versions becomes easier and overall we have better distinction between generated code and handwritten.
| "path_to_docs": "docs/source", | ||
| "repository_branch": "main", | ||
| "repository_url": "https://github.com/mamba-org/mamba", | ||
| "use_download_button": True, | ||
| "use_edit_page_button": True, | ||
| "use_issues_button": True, |
There was a problem hiding this comment.
I added a few nice options here, which add a few buttons under GitHub logo and also make issues links more beautiful (if there will be any)
|
|
||
| # Configure links which should be ignored during linkcheck | ||
| linkcheck_ignore = [ | ||
| r".*github\.com.*#", # javascript based anchors |
There was a problem hiding this comment.
GitHub Readme files have javascript based anchors, which causes linkcheck errors. I also fixed 2 redirect warnings below.
Now, docs links are correct (and maybe I will add a CI step later in a separate PR)
|
@jjerphan any chance to merge this? |
|
I think that it would be appropriate activating the rendering of Pull Requests' documentation rendering first, i.e. what you proposed with #3598. |
|
It looks like I don't have the permission to do that, so I would be in favor of merging this PR. |
No description provided.