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

Building the documentation raises an error and warnings #243

Closed
sandcha opened this issue Jul 16, 2021 · 1 comment · Fixed by #251
Closed

Building the documentation raises an error and warnings #243

sandcha opened this issue Jul 16, 2021 · 1 comment · Fixed by #251

Comments

@sandcha
Copy link
Contributor

sandcha commented Jul 16, 2021

When I build the documentation, I get some red lines for:

  • an ERROR: Malformed table
  • two docstrings WARNING: 'any' reference target not found (...)
  • and a UserWarning: Unsupported inline type Hardbreak

What did I do?

In a new virtual environment, I installed the dependencies with pip install -r requirements.txt --use-deprecated=legacy-resolver.

An I executed make html command.

What did I expect?

A make html output without error.

What did I find?

This output:

$ make html
Running Sphinx v1.5
making output directory...
loading pickled environment... not yet created
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 68 source files that are out of date
updating environment: 68 added, 0 changed, 0 removed
.../virtualenvs/doc/lib/python3.7/site-packages/recommonmark/parser.py:280: UserWarning: Unsupported inline type Hardbreak                   
  warn("Unsupported inline type " + inline.t)
reading sources... [100%] summary                                                                                                                                
docstring of openfisca_core.tools.test_runner.run_tests:15: ERROR: Malformed table.

+-------------------------------+-----------+-------------------------------------------+
| Key                           | Type      | Role                                      |
+===============================+===========+===========================================+
| verbose                       | ``bool``  |                                           |
+-------------------------------+-----------+ See :any:`openfisca_test` options doc +
| name_filter                   | ``str``   |                                           |
+-------------------------------+-----------+-------------------------------------------+
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] summary                                                                                                                                 
.../virtualenvs/doc/src/openfisca-core/openfisca_core/simulations/simulation.py:docstring of openfisca_core.simulations.Simulation.get_array:3: WARNING: 'any' reference target not found: calculate
.../virtualenvs/doc/src/openfisca-core/openfisca_core/simulations/simulation.py:docstring of openfisca_core.simulations.Simulation.get_holder:1: WARNING: 'any' reference target not found: Holder
generating indices... genindex py-modindex
highlighting module code... [100%] openfisca_core.tools.test_runner                                                                                              
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 3 warnings.

Build finished. The HTML pages are in build/html.

Besides, in the same virtual environment, the make dev command also raises the error and warnings.

@bonjourmauko
Copy link
Member

This is fixed by #251 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants