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

Sphinx warnings #1192

Closed
tmylk opened this issue Mar 7, 2017 · 1 comment
Closed

Sphinx warnings #1192

tmylk opened this issue Mar 7, 2017 · 1 comment
Labels
bug Issue described a bug difficulty easy Easy issue: required small fix documentation Current issue related to documentation

Comments

@tmylk
Copy link
Contributor

tmylk commented Mar 7, 2017

Sphinx 1.5.3 raises 108 warnings when generating gensim docs when running

cd docs/src
make clean html 

All the files are generated correctly even though Sphinx labels some of the warnings as errors.

The easiest warnings to fix are in the rst files of type Title underline too short.

The warnings in the py file are hard to fix because the line numbers listed in the error messages don't correspond to the line numbers in the files. For example, there is no docstring on line 41 though sphinx reports
coherencemodel.py:docstring of gensim.models.coherencemodel.CoherenceModel:41: ERROR: Unexpected indentation.

@tmylk tmylk added bug Issue described a bug documentation Current issue related to documentation difficulty easy Easy issue: required small fix labels Mar 7, 2017
prerna135 added a commit to prerna135/gensim that referenced this issue Jun 22, 2017
Fixes warnings in the .py files
@menshikh-iv
Copy link
Contributor

Finished in #1442

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Issue described a bug difficulty easy Easy issue: required small fix documentation Current issue related to documentation
Projects
None yet
Development

No branches or pull requests

2 participants