Skip to content
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

Improve documentation #4

Merged
merged 4 commits into from Sep 14, 2023
Merged

Improve documentation #4

merged 4 commits into from Sep 14, 2023

Conversation

patacca
Copy link
Collaborator

@patacca patacca commented Sep 13, 2023

Improve the documentation both visually and content-wise.
List of changes:

There is still one major compatibility problem with sphinx-tabs (required by enum-tools[sphinx]). For some reason sphinx-tabs requires docutils 0.18.* but most of the other packages specifically avoid 0.18.* and 0.19.* as they are known to be buggy. Right now everything we are using is compatible with docutils 0.20.* except from sphinx-tabs.
I've checked and sphinx-tabs doesn't seem to complain if we force the installation of docutils 0.20.*
There is an open request to remove the strict (useless?) requirement of docutils from sphinx-tabs executablebooks/sphinx-tabs#171 but since they will address the issue we will still have to rely on manually forcing the installation of docutils 0.20.*

Example of a standard installation:

$ pip install -r requirements.txt
....
$ pip install enum-tools[sphinx]
... Some errors will occur ...
$ pip install docutils==0.20.1
... Warning for the incompatibility with sphinx-tabs ...
$ # Safe to use now

@RobinDavid RobinDavid merged commit 75f035e into main Sep 14, 2023
@patacca patacca deleted the clean_doc branch September 14, 2023 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants