question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Building documentation generates a lot of warnings

See original GitHub issue

Describe the problem

Building documentation for read-the-docs at the current master generates a lot of warnings. Commit from which it started: b1c6e75f4c8442195e8551b561ba62479cac75c4 Reproducer:

cd MODIN_ROOT_FOLDER/docs
python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
Output:
WARNING: autodoc: failed to import module 'spreadsheet.general' from module 'modin'; the following exception was raised:
Please `pip install modin[spreadsheet]` to install the spreadsheet extension
WARNING: autodoc: failed to import module 'spreadsheet.general' from module 'modin'; the following exception was raised:
Please `pip install modin[spreadsheet]` to install the spreadsheet extension
WARNING: autodoc: failed to import module 'grid' from module 'modin_spreadsheet'; the following exception was raised:
No module named 'modin_spreadsheet'
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.clip:17: WARNING: Inline strong start-string without end-string.
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.cummax:11: WARNING: Inline strong start-string without end-string.
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.cummin:11: WARNING: Inline strong start-string without end-string.
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.cumprod:11: WARNING: Inline strong start-string without end-string.
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.cumsum:11: WARNING: Inline strong start-string without end-string.
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_latex:92: WARNING: Unexpected section title.

Returns
-------
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_sql:68: WARNING: Duplicate explicit target name: "1".
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_sql:69: WARNING: Footnote [2] is not referenced.
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_pickle:15: WARNING: Duplicate target name, cannot be used as a unique reference: "1".
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_sql:3: WARNING: Duplicate target name, cannot be used as a unique reference: "1".
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.dropna:3: WARNING: undefined label: missing_data (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.ewm:95: WARNING: undefined label: window.exponentially_weighted (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.iloc:22: WARNING: undefined label: indexing.integer (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.loc:25: WARNING: undefined label: indexing.label (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.mask:50: WARNING: undefined label: indexing.where_mask (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.reindex:196: WARNING: undefined label: basics.reindexing (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_hdf:11: WARNING: undefined label: io.hdf5 (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_hdf:59: WARNING: undefined label: io.hdf5-query-data-columns (if the link has no caption the label must precede a section header)
modin\modin\pandas\base.py:docstring of modin.pandas.base.BasePandasDataset.to_sql:43: WARNING: undefined label: io.sql.method (if the link has no caption the label must precede a section header)

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

1reaction
amyskovcommented, Mar 9, 2022

It is decided to use the approach we apply for modin.pandas.DataFrame/Series. @amyskov, will you handle this?

Yes, assigned task to me.

0reactions
mvashishthacommented, Oct 12, 2022

The reproducer doesn’t give me all those warnings at modin 88f7b27d32b099c508e93251cafe503f2908d426 any more.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Sphinx emits lots of warnings when building docs #911
Sphinx currently emits a few types of warnings when building the docs, none are really a big deal but it clutters the output...
Read more >
Lots of warnings when building with Xcode 7 with 3rd party ...
I am getting a large number of warnings when compiling my project in Xcode 7 GM (bitcode is NOT enabled) in regards to...
Read more >
How to turn warnings into errors when building sphinx ...
I am using setuptools to build my sphinx documentation ...
Read more >
Project build errors and warnings (PRJxxxx)
The Visual Studio compilers and build tools can report many kinds of errors and warnings. After an error or warning is found, the...
Read more >
Warnings Next Generation Plugin
The healthy threshold defines the limit of warnings for a healthy result: A build is considered as 100% healthy when the number of...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found