0.5.11: shphinx warnings

[kloczek]

+ /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinx
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
WARNING: html_static_path entry '_static' does not exist
loading intersphinx inventory from https://docs.python.org/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: [new config] 42 added, 0 changed, 0 removed
reading sources... [100%] index
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Earth, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Jupiter, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Mars, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Mercury, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Minor, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Moon, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Neptune, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Pluto, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Saturn, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Sun, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Uranus, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Venus, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Angle, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Coordinates, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/CurveFitting, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Epoch, use :noindex: for one of them
/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Interpolation, use :noindex: for one of them
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
writing... pymeeus.1 { core/index core/base core/Angle core/Coordinates core/CurveFitting core/Epoch core/Interpolation bodies/index bodies/Earth bodies/JupiterMoons bodies/Jupiter bodies/Mars bodies/Mercury bodies/Minor bodies/Moon bodies/Neptune bodies/Pluto bodies/Saturn bodies/Sun bodies/Uranus bodies/Venus examples/index examples/ex-Angle examples/ex-base examples/ex-Coordinates examples/ex-CurveFitting examples/ex-Earth examples/ex-Epoch examples/ex-Interpolation examples/ex-Jupiter examples/ex-JupiterMoons examples/ex-Mars examples/ex-Mercury examples/ex-Minor examples/ex-Moon examples/ex-Neptune examples/ex-Pluto examples/ex-Saturn examples/ex-Sun examples/ex-Uranus examples/ex-Venus } done
build succeeded, 18 warnings.

[architest]

Dear Mr. Kloczko: Are you using the method indicated in pymeeus/docs/REAME.txt to generate your sphinx documentation?. I use "make html" from directory "pymeeus/docs" and I get no warning at all. Best regards, Dagoberto Salazar

…

On Tue, Jun 15, 2021 at 3:53 PM Tomasz Kłoczko ***@***.***> wrote: + /usr/bin/python3 setup.py build_sphinx -b man --build-dir build/sphinxrunning build_sphinxRunning Sphinx v4.0.2making output directory... doneWARNING: html_static_path entry '_static' does not existloading intersphinx inventory from https://docs.python.org/objects.inv...intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.invbuilding [mo]: targets for 0 po files that are out of datebuilding [man]: all manpagesupdating environment: [new config] 42 added, 0 changed, 0 removedreading sources... [100%] index/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Earth, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Jupiter, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Mars, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Mercury, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Minor, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Moon, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Neptune, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Pluto, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Saturn, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Sun, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Uranus, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in bodies/Venus, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Angle, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Coordinates, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/CurveFitting, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Epoch, use :noindex: for one of them/home/tkloczko/rpmbuild/BUILD/PyMeeus-0.5.11/pymeeus/__init__.py:docstring of pymeeus:1: WARNING: duplicate object description of pymeeus, other instance in core/Interpolation, use :noindex: for one of themlooking for now-outdated files... none foundpickling environment... donechecking consistency... donewriting... pymeeus.1 { core/index core/base core/Angle core/Coordinates core/CurveFitting core/Epoch core/Interpolation bodies/index bodies/Earth bodies/JupiterMoons bodies/Jupiter bodies/Mars bodies/Mercury bodies/Minor bodies/Moon bodies/Neptune bodies/Pluto bodies/Saturn bodies/Sun bodies/Uranus bodies/Venus examples/index examples/ex-Angle examples/ex-base examples/ex-Coordinates examples/ex-CurveFitting examples/ex-Earth examples/ex-Epoch examples/ex-Interpolation examples/ex-Jupiter examples/ex-JupiterMoons examples/ex-Mars examples/ex-Mercury examples/ex-Minor examples/ex-Moon examples/ex-Neptune examples/ex-Pluto examples/ex-Saturn examples/ex-Sun examples/ex-Uranus examples/ex-Venus } donebuild succeeded, 18 warnings. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#13>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFQIZWJQ3YRCBT4T3VWGKZLTS5LPDANCNFSM46XKL3PA> .

[kloczek]

It doesn't matter which one method will be used.
Please check which one sphinx version you have.
If you don't see those warnings it means that you are not using sphinx >= 4.0 (latest is 4.0.2).
I don't need html and as you see I'm generating man pages roff output because that is basic documentation format on all U*nix systems.
Just in case: those warnings are output format independent.

PS. Using setuptools "build_sphinx" command allows to generated documentation without knowing where is copy.py so it is the best generic method. You wasted your time on writhing that Makefile file. If you are interested you can run python setup.py --help-commands to see what more offers setuptools.

[architest]

I used your method and noticed that the Sphinx version is v1.8.5. That is the one that comes with Ubuntu 20.04, which is the platform I use. It ran flawlessly. Dagoberto

…

On Tue, Jun 15, 2021 at 5:08 PM Tomasz Kłoczko ***@***.***> wrote: It doesn't matter which one method will be used. Please check which one sphinx version you have. If you don't see those warnings it means that you are not using sphinx >= 4.0 (latest is 4.0.2). I don't need html and as you see I'm generating man pages roff output because that is basic documentation format on all U*nix systems. Just in case: those warnings are output format independent. PS. Using setuptools "build_sphinx" command allows to generated documentation without knowing where is copy.py so it is the best generic method. You wasted your time on writhing that Makefile file. If you are interested you can run python setup.py --help-commands to see what more offers setuptools. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#13 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFQIZWI4KNMBI2Z4ZPXW3FTTS5UINANCNFSM46XKL3PA> .

[kloczek]

Sphinx 1.8.5 was released more than two years ago https://github.com/sphinx-doc/sphinx/releases/tag/v1.8.5
Year ago when Ubuntu 20.04 was released already was widely used sphinx 3.x. Now is used 4.x which is more sensitive about some errors and warnings.
If you will apply proper fixes for 4.x still Sphinx 1.8.5 should be OK.
I'm doing full review of my modules on building documentation using sphinx 4.0.2 and I've already created many tickets for that kind of issues so your module is not only one :)

[tkloczko@barrel SPECS]$ grep "\# BUG: sphinx warnings" python-*
python-aspectlib.spec:# BUG: sphinx warnings https://github.com/ionelmc/python-aspectlib/issues/20
python-dropbox.spec:# BUG: sphinx warnings https://github.com/dropbox/dropbox-sdk-python/issues/359
python-elementpath.spec:# BUG: sphinx warnings https://github.com/sissaschool/elementpath/issues/38
python-execnet.spec:# BUG: sphinx warnings https://github.com/pytest-dev/execnet/issues/140
python-faker.spec:# BUG: sphinx warnings https://github.com/joke2k/faker/issues/1456
python-gitdb.spec:# BUG: sphinx warnings https://github.com/gitpython-developers/gitdb/issues/71
python-hamcrest.spec:# BUG: sphinx warnings https://github.com/hamcrest/PyHamcrest/issues/174
python-hyperframe.spec:# BUG: sphinx warnings https://github.com/python-hyper/hyperframe/issues/159
python-importlib-metadata.spec:# BUG: sphinx warnings https://github.com/python/importlib_metadata/issues/309
python-inflect.spec:# BUG: sphinx warnings https://github.com/jaraco/inflect/issues/132
python-installer.spec:# BUG: sphinx warnings https://github.com/sarugaku/installer/issues/6
python-jaraco.itertools.spec:# BUG: sphinx warnings https://github.com/jaraco/jaraco.itertools/issues/12
python-jaraco-text.spec:# BUG: sphinx warnings https://github.com/jaraco/jaraco.text/issues/5
python-kombu.spec:# BUG: sphinx warnings https://github.com/celery/kombu/issues/1347
python-lark.spec:# BUG: sphinx warnings https://github.com/lark-parser/lark/issues/903
python-parver.spec:# BUG: sphinx warnings https://github.com/RazerM/parver/issues/16
python-path.spec:# BUG: sphinx warnings https://github.com/jaraco/path/issues/201
python-pbr.spec:# BUG: sphinx warnings https://bugs.launchpad.net/pbr/+bug/1930618
python-productmd.spec:# BUG: sphinx warnings https://github.com/release-engineering/productmd/issues/156
python-prompt-toolkit.spec:# BUG: sphinx warnings https://github.com/prompt-toolkit/python-prompt-toolkit/issues/1435
python-pymeeus.spec:# BUG: sphinx warnings https://github.com/architest/pymeeus/issues/13
python-pyOpenSSL.spec:# BUG: sphinx warnings https://github.com/pyca/pyopenssl/issues/1023
python-pytest.spec:# BUG: sphinx warnings https://github.com/pytest-dev/pytest/issues/8730
python-pyxattr.spec:# BUG: sphinx warnings https://github.com/iustin/pyxattr/issues/27
python-rdflib.spec:# BUG: sphinx warnings https://github.com/RDFLib/rdflib/issues/1334
python-requests-toolbelt.spec:# BUG: sphinx warnings https://github.com/requests/toolbelt/issues/310
python-sphinxcontrib-autoprogram.spec:# BUG: sphinx warnings https://github.com/sphinx-contrib/autoprogram/issues/50
python-sphinx_rtd_theme.spec:# BUG: sphinx warnings https://github.com/readthedocs/sphinx_rtd_theme/issues/1157
python-systemd.spec:# BUG: sphinx warnings https://github.com/systemd/python-systemd/issues/96
python-traitlets.spec:# BUG: sphinx warnings https://github.com/ipython/traitlets/issues/664
python-trio.spec:# BUG: sphinx warnings https://github.com/python-trio/trio/issues/2018
python-WSGIProxy2.spec:# BUG: sphinx warnings https://github.com/gawel/WSGIProxy2/issues/28
python-xmlschema.spec:# BUG: sphinx warnings https://github.com/sissaschool/xmlschema/issues/248

[architest]

The problem is that the warnings are very vague and I don't have a clue where to look at. And with only Sphinx 1.8.5 installed I don't have a way to even try. Dagoberto

…

On Tue, Jun 15, 2021 at 6:35 PM Tomasz Kłoczko ***@***.***> wrote: Sphinx 1.8.5 was released more than two years ago https://github.com/sphinx-doc/sphinx/releases/tag/v1.8.5 Year ago when Ubuntu 20.04 was released already was widely used sphinx 3.x. Now is used 4.x which is more sensitive about some errors and warnings. If you will apply proper fixes for 4.x still Sphinx 1.8.5 should be OK. I'm doing full review of my modules on building documentation using sphinx 4.0.2 and I've already created many tickets for that kind of issues so your module is not only one :) ***@***.*** SPECS]$ grep "\# BUG: sphinx warnings" python-*python-aspectlib.spec:# BUG: sphinx warnings https://github.com/ionelmc/python-aspectlib/issues/20python-dropbox.spec:# BUG: sphinx warnings https://github.com/dropbox/dropbox-sdk-python/issues/359python-elementpath.spec:# BUG: sphinx warnings https://github.com/sissaschool/elementpath/issues/38python-execnet.spec:# BUG: sphinx warnings https://github.com/pytest-dev/execnet/issues/140python-faker.spec:# BUG: sphinx warnings https://github.com/joke2k/faker/issues/1456python-gitdb.spec:# BUG: sphinx warnings https://github.com/gitpython-developers/gitdb/issues/71python-hamcrest.spec:# BUG: sphinx warnings https://github.com/hamcrest/PyHamcrest/issues/174python-hyperframe.spec:# BUG: sphinx warnings https://github.com/python-hyper/hyperframe/issues/159python-importlib-metadata.spec:# BUG: sphinx warnings https://github.com/python/importlib_metadata/issues/309python-inflect.spec:# BUG: sphinx warnings https://github.com/jaraco/inflect/issues/132python-installer.spec:# BUG: sphinx warnings https://github.com/sarugaku/installer/issues/6python-jaraco.itertools.spec:# BUG: sphinx warnings https://github.com/jaraco/jaraco.itertools/issues/12python-jaraco-text.spec:# BUG: sphinx warnings https://github.com/jaraco/jaraco.text/issues/5python-kombu.spec:# BUG: sphinx warnings https://github.com/celery/kombu/issues/1347python-lark.spec:# BUG: sphinx warnings https://github.com/lark-parser/lark/issues/903python-parver.spec:# BUG: sphinx warnings https://github.com/RazerM/parver/issues/16python-path.spec:# BUG: sphinx warnings https://github.com/jaraco/path/issues/201python-pbr.spec:# BUG: sphinx warnings https://bugs.launchpad.net/pbr/+bug/1930618python-productmd.spec:# BUG: sphinx warnings https://github.com/release-engineering/productmd/issues/156python-prompt-toolkit.spec:# BUG: sphinx warnings https://github.com/prompt-toolkit/python-prompt-toolkit/issues/1435python-pymeeus.spec:# BUG: sphinx warnings https://github.com/architest/pymeeus/issues/13python-pyOpenSSL.spec:# BUG: sphinx warnings https://github.com/pyca/pyopenssl/issues/1023python-pytest.spec:# BUG: sphinx warnings https://github.com/pytest-dev/pytest/issues/8730python-pyxattr.spec:# BUG: sphinx warnings https://github.com/iustin/pyxattr/issues/27python-rdflib.spec:# BUG: sphinx warnings https://github.com/RDFLib/rdflib/issues/1334python-requests-toolbelt.spec:# BUG: sphinx warnings https://github.com/requests/toolbelt/issues/310python-sphinxcontrib-autoprogram.spec:# BUG: sphinx warnings https://github.com/sphinx-contrib/autoprogram/issues/50python-sphinx_rtd_theme.spec:# BUG: sphinx warnings https://github.com/readthedocs/sphinx_rtd_theme/issues/1157python-systemd.spec:# BUG: sphinx warnings https://github.com/systemd/python-systemd/issues/96python-traitlets.spec:# BUG: sphinx warnings https://github.com/ipython/traitlets/issues/664python-trio.spec:# BUG: sphinx warnings https://github.com/python-trio/trio/issues/2018python-WSGIProxy2.spec:# BUG: sphinx warnings https://github.com/gawel/WSGIProxy2/issues/28python-xmlschema.spec:# BUG: sphinx warnings sissaschool/xmlschema#248 — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#13 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFQIZWL2332G3BNWADOGWPTTS56OFANCNFSM46XKL3PA> .