Fix Sphinx warnings #74

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

Jump to bottom

Merged

Byron merged 1 commit into gitpython-developers:master from hugovk:fix-sphinx-warnings

Aug 19, 2021

Merged

Fix Sphinx warnings #74

Byron merged 1 commit into gitpython-developers:master from hugovk:fix-sphinx-warnings

Aug 19, 2021

Conversation

hugovk

Copy link

Contributor

@hugovk hugovk commented Aug 19, 2021

Fixes #71.

Two things:

There is no .static dir in use, comment it out
Docstrings usually need a new line between a summary and the params/return: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

$ python3 setup.py build_sphinx -b man
running build_sphinx
Running Sphinx v4.0.2
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [man]: all manpages
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
writing... gitdb.1 { intro tutorial api algorithm changes } done
build succeeded.
The manual pages are in build/sphinx/man.