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

Use sphinx 4.0+ #21

Closed
krashish8 opened this issue Nov 15, 2021 · 0 comments
Closed

Use sphinx 4.0+ #21

krashish8 opened this issue Nov 15, 2021 · 0 comments
Assignees
Labels
Build documentation Improvements or additions to documentation
Milestone

Comments

@krashish8
Copy link
Member

Problem
Recent build fails for Check Links: https://github.com/pgRouting/vrprouting/runs/4207900423?check_suite_focus=true#step:11:16

WARNING: while setting up extension sphinx.addnodes: node class 'meta' is already registered, its visitors will be overridden
...
build finished with problems, 1 warning.

It is a warning, but warnings are treated as errors, because we use -W flag in sphinx command.

With reference to sphinx-doc/sphinx#9841, this is probably because during pip install, a higher version of docutils is used. So, either we need to restrict docutils to 0.17, or upgrade Sphinx.

As pgRouting uses Sphinx>4.0.0, we can also use it. (pgRouting/pgrouting#2178)

Improvement
Use Sphinx version 4.0 or greater.

This will also imply to use a more resent version of bootstrap

@krashish8 krashish8 added documentation Improvements or additions to documentation Build labels Nov 15, 2021
@krashish8 krashish8 self-assigned this Nov 15, 2021
@krashish8 krashish8 added this to the Release 0.3.0 milestone Nov 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant