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

Documentation is outdated due to a build error #1697

Closed
M0NsTeRRR opened this issue Jul 12, 2022 · 7 comments
Closed

Documentation is outdated due to a build error #1697

M0NsTeRRR opened this issue Jul 12, 2022 · 7 comments

Comments

@M0NsTeRRR
Copy link
Contributor

Hello,

Documentation hosted on RTD is outdated, there is an issue when building the documentation

https://readthedocs.org/projects/napalm/builds

Last successfull operation was 3 months ago

@M0NsTeRRR
Copy link
Contributor Author

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/registry.py", line 472, in load_extension
    mod = __import__(extname, None, None, ['setup'])
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/builders/latex/__init__.py", line 37, in <module>
    from sphinx.writers.latex import DEFAULT_SETTINGS, LaTeXWriter, LaTeXTranslator
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/writers/latex.py", line 33, in <module>
    from sphinx.util.template import LaTeXRenderer
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/util/template.py", line 17, in <module>
    from sphinx.jinja2glue import SphinxFileSystemLoader
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/jinja2glue.py", line 16, in <module>
    from jinja2 import FileSystemLoader, BaseLoader, TemplateNotFound, \
ImportError: cannot import name 'contextfunction' from 'jinja2' (/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/jinja2/__init__.py)

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/cmd/build.py", line 303, in build_main
    args.tags, args.verbosity, args.jobs, args.keep_going)
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/application.py", line 224, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/application.py", line 449, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/sphinx/registry.py", line 475, in load_extension
    raise ExtensionError(__('Could not import extension %s') % extname, err)
sphinx.errors.ExtensionError: Could not import extension sphinx.builders.latex (exception: cannot import name 'contextfunction' from 'jinja2' (/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/jinja2/__init__.py))

Extension error:
Could not import extension sphinx.builders.latex (exception: cannot import name 'contextfunction' from 'jinja2' (/home/docs/checkouts/readthedocs.org/user_builds/napalm/envs/stable/lib/python3.7/site-packages/jinja2/__init__.py))

jinja2

Probably related with this mkdocs/mkdocs#2799

@ktbyers
Copy link
Contributor

ktbyers commented Jul 12, 2022

Should be fixed here:

#1700

This PR still needs to be merged.

@ktbyers
Copy link
Contributor

ktbyers commented Jul 12, 2022

@M0NsTeRRR Thanks for letting us know.

@M0NsTeRRR
Copy link
Contributor Author

Build is still failling, I don't have time to look into in before one or two weeks

@M0NsTeRRR
Copy link
Contributor Author

M0NsTeRRR commented Aug 17, 2022

I assume it works with #1734 make doctest

build succeeded.

The HTML pages are in _build/html.

It's a little ugly some dependencies are outdated, an other issue should be opened to clean and upgrade documentation dependencies, also all dependencies should be pinned with their appropriate version.
There is a lot of requirements.txt file maybe we could reduce the number.

@M0NsTeRRR
Copy link
Contributor Author

I don't know why there is an error on test, on my laptop I don't get this if someone can look into in

@M0NsTeRRR
Copy link
Contributor Author

I've added this PR that should fix readthedoc build

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