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

[chores] Added ReadTheDocs configuration #211 #224

Merged
merged 1 commit into from Mar 28, 2022

Conversation

pandafy
Copy link
Member

@pandafy pandafy commented Mar 28, 2022

Closes #211

@pandafy
Copy link
Member Author

pandafy commented Mar 28, 2022

The ReadTheDocs build is passing for this PR: https://readthedocs.org/projects/netjsonconfig/builds/16487366/

@coveralls
Copy link

coveralls commented Mar 28, 2022

Coverage Status

Coverage remained the same at 99.604% when pulling 6f01968 on issues/211-read-the-docs into 760911c on master.

@pandafy pandafy requested a review from nemesifier March 28, 2022 11:02
Copy link
Member

@nemesifier nemesifier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still failing:

Running Sphinx v1.8.6
loading translations [en]... done
making output directory...
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [latex]: all documents
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
processing netjsonconfig.tex...index general/setup general/basics backends/openwrt backends/openwisp backends/vpn backends/openvpn backends/wireguard backends/vxlan_over_wireguard backends/create_your_backend general/commandline_utility general/running_tests general/contributing general/goals general/changelog 
resolving references...
/home/docs/checkouts/readthedocs.org/user_builds/netjsonconfig/envs/issues-211-read-the-docs/lib/python3.8/site-packages/sphinx/builders/latex/__init__.py:201: FutureWarning: 
   The iterable returned by Node.traverse()
   will become an iterator instead of a list in Docutils > 0.16.
  if toctrees[0].get('maxdepth') > 0:
/home/docs/checkouts/readthedocs.org/user_builds/netjsonconfig/checkouts/issues-211-read-the-docs/docs/source/index.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://travis-ci.org/openwisp/netjsonconfig.svg)
/home/docs/checkouts/readthedocs.org/user_builds/netjsonconfig/checkouts/issues-211-read-the-docs/docs/source/index.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://coveralls.io/repos/openwisp/netjsonconfig/badge.svg)
/home/docs/checkouts/readthedocs.org/user_builds/netjsonconfig/checkouts/issues-211-read-the-docs/docs/source/index.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://img.shields.io/librariesio/release/github/openwisp/netjsonconfig)
/home/docs/checkouts/readthedocs.org/user_builds/netjsonconfig/checkouts/issues-211-read-the-docs/docs/source/index.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://badge.fury.io/py/netjsonconfig.svg)
/home/docs/checkouts/readthedocs.org/user_builds/netjsonconfig/checkouts/issues-211-read-the-docs/docs/source/index.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://img.shields.io/gitter/room/nwjs/nw.js.svg?style=flat-square)
writing... 
Markup is unsupported in LaTeX:
backends/wireguard:: nested tables are not yet implemented.

@nemesifier
Copy link
Member

Let's try it one more time.

@nemesifier nemesifier merged commit 047afe0 into master Mar 28, 2022
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 this pull request may close these issues.

[docs] Fix the readthedocs failing build
3 participants