fix various documentation warnings #3077
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I encountered the following while building under Sphinx 3.5.2 on MacOS: docstring of gensim.corpora._mmreader.MmReader.num_docs:1:duplicate object description of gensim.corpora._mmreader.MmReader.num_docs, other instance in corpora/_mmreader, use :noindex: for one of them gensim/gensim/utils.py:docstring of gensim.utils.chunkize:9:Inline interpreted text or phrase reference start-string without end-string. gensim/docs/src/_matutils.rst:document isn't included in any toctree
IIRC Ivan couldn't get the docs to run on Sphinx 3 at all: Does this mean Sphinx 3 works now? If so, the |
|
Yeah, I think that comment is out of date. I'll try removing the pin, but it's possible it will cause a massive rebuild of everything, which isn't what we want. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I encountered the following while building under Sphinx 3.5.2 on MacOS:
docstring of gensim.corpora._mmreader.MmReader.num_docs:1:duplicate object description of gensim.corpora._mmreader.MmReader.num_docs, other instance in corpora/_mmreader, use :noindex: for one of them
gensim/gensim/utils.py:docstring of gensim.utils.chunkize:9:Inline interpreted text or phrase reference start-string without end-string.
gensim/docs/src/_matutils.rst:document isn't included in any toctree