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

update sphinx to 3.0.1 #56671

Merged
merged 1 commit into from
Apr 18, 2020
Merged

update sphinx to 3.0.1 #56671

merged 1 commit into from
Apr 18, 2020

Conversation

bryceml
Copy link
Contributor

@bryceml bryceml commented Apr 16, 2020

What does this PR do?

tests running sphinx and lint on python3.7.6 with sphinx updated to 3.0.1

@alan-cugler
Copy link
Contributor

https://github.com/saltstack/salt/blob/master/doc/conf.py#L12 needs to be changed to such

from sphinx.directives.other import TocTree

and then we can delete the duplicate concurrent, seeing as that is built into salt python 3
https://github.com/saltstack/salt/blob/master/doc/conf.py#L89
https://github.com/saltstack/salt/blob/master/doc/conf.py#L153

@bryceml
Copy link
Contributor Author

bryceml commented Apr 16, 2020

These are the warnings I get when running locally without -W as a sphinx option:

building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1737 source files that are out of date
updating environment: [new config] 1737 added, 0 changed, 0 removed
reading sources... [100%] topics/yaml/index                                                                                                                                                                                                                                      
/code/doc/ref/configuration/minion.rst:713: WARNING: duplicate conf_master description of color_theme, other instance in ref/configuration/master
/code/doc/ref/configuration/minion.rst:2591: WARNING: duplicate conf_minion description of pillarenv_from_saltenv, other instance in ref/configuration/master
/code/salt/cloud/clouds/openstack.py:docstring of salt.cloud.clouds.openstack:1: WARNING: duplicate object description of salt.cloud.clouds.openstack, other instance in ref/clouds/all/salt.cloud.clouds.openstack, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] topics/yaml/index                                                                                                                                                                                                                                       
/code/doc/glossary.rst:72: WARNING: term not in glossary: job
/code/doc/glossary.rst:195: WARNING: term not in glossary: highdata
/code/doc/ref/configuration/index.rst:7: WARNING: term not in glossary: master
/code/doc/ref/configuration/index.rst:7: WARNING: term not in glossary: minion
/code/doc/topics/beacons/index.rst:241: WARNING: term not in glossary: idempotent
/code/doc/topics/grains/index.rst:105: WARNING: term not in glossary: top file
/code/doc/topics/targeting/compound.rst:7: WARNING: term not in glossary: top file
/code/doc/topics/targeting/compound.rst:37: WARNING: term not in glossary: top file
/code/doc/topics/targeting/globbing.rst:14: WARNING: term not in glossary: minion id
/code/doc/topics/targeting/globbing.rst:21: WARNING: term not in glossary: minion id
/code/doc/topics/targeting/globbing.rst:21: WARNING: term not in glossary: top file
/code/doc/topics/targeting/globbing.rst:86: WARNING: term not in glossary: top file
/code/doc/topics/targeting/index.rst:15: WARNING: term not in glossary: top file
/code/doc/topics/targeting/nodegroups.rst:65: WARNING: term not in glossary: top file
/code/doc/topics/targeting/nodegroups.rst:70: WARNING: term not in glossary: top file
/code/doc/topics/tutorials/http.rst:186: WARNING: Could not lex literal_block as "python". Highlighting skipped.
/code/doc/topics/tutorials/modules.rst:12: WARNING: term not in glossary: master
/code/doc/topics/tutorials/modules.rst:12: WARNING: term not in glossary: minion
/code/doc/topics/tutorials/pillar.rst:142: WARNING: term not in glossary: top file
generating indices...  genindex py-modindexdone
writing additional pages...  404 searchdone
copying images... [100%] _static/spm-package-extraction.png                                                                                                                                                                                                                      
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 22 warnings.

@bryceml
Copy link
Contributor Author

bryceml commented Apr 16, 2020

I think I fixed all the warnings, we'll see.

@bryceml bryceml changed the title test updating sphinx update sphinx to 3.0.1 Apr 17, 2020
@bryceml bryceml marked this pull request as ready for review April 17, 2020 05:56
@bryceml bryceml requested a review from a team as a code owner April 17, 2020 05:56
@ghost ghost requested review from Akm0d and removed request for a team April 17, 2020 05:56
@bryceml bryceml added the Documentation Relates to Salt documentation label Apr 17, 2020
@dwoz dwoz merged commit 86c2fb8 into saltstack:master Apr 18, 2020
@bryceml bryceml deleted the update_sphinx branch April 18, 2020 13:28
@sagetherage sagetherage added the ZRelease-Sodium retired label label May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to Salt documentation ZRelease-Sodium retired label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants