Page MenuHomeSoftware Heritage
Paste P988

swh-docs: make -C docs clean; make -C docs
ActivePublic
Actions

Authored by ardumont on Mar 25 2021, 4:53 PM.
swh  tony  yavin4  ~  work  …  swh  swh-environment  swh-auth   master  1⬆  1✎  1⚑  %  make -C docs clean
make: Entering directory '/home/tony/work/inria/repo/swh/swh-environment/swh-auth/docs'
sphinx-build -M clean . _build
Removing everything under '_build'...
rm -rf apidoc
rm -f *-stamp
make: Leaving directory '/home/tony/work/inria/repo/swh/swh-environment/swh-auth/docs'
swh  tony  yavin4  ~  work  …  swh  swh-environment  swh-auth   master  1⬆  1✎  1⚑  %  make -C docs make: Entering directory '/home/tony/work/inria/repo/swh/swh-environment/swh-auth/docs'
sphinx-apidoc --ext-viewcode --separate -o apidoc .. . ../setup.py ../swh/*/tests ../swh/*/tests/* ../swh/*/*/tests/* ../swh/*/*/*/tests/* ../swh/*/migrations ../swh/*/migrations/* ../swh/*/*/migrations/* ../swh/*/*/*/migrations/* ../bin/* ../utils/* ../node_modules/* ../swh/auth/tests/django/app/apptest/*
Creating file apidoc/conftest.rst.
Creating file apidoc/swh.rst.
Creating file apidoc/swh.auth.rst.
Creating file apidoc/swh.auth.cli.rst.
Creating file apidoc/swh.auth.keycloak.rst.
Creating file apidoc/swh.auth.pytest_plugin.rst.
Creating file apidoc/swh.auth.django.rst.
Creating file apidoc/swh.auth.django.models.rst.
Creating file apidoc/swh.auth.django.utils.rst.
Creating file apidoc/modules.rst.
# to silent Sphinx warnings about apidoc documents not included in any toctree
find /home/tony/work/inria/repo/swh/swh-environment/swh-auth/docs/apidoc -name "*.rst" | xargs sed -i '1i:orphan:\n'
touch apidoc-stamp
sphinx-build -b html . _build/html
Running Sphinx v3.3.0
loading translations [en]... done
making output directory... done
Exception occurred:
File "/home/tony/work/inria/repo/swh/swh-environment/swh-docs/swh/docs/django_settings.py", line 2, in <module>
import swh.web.settings.development as web
ModuleNotFoundError: No module named 'swh.web.settings'
The full traceback has been saved in /tmp/sphinx-err-a41dd2y9.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [../../swh-docs/Makefile.sphinx:36: sphinx/html] Error 2
make: Leaving directory '/home/tony/work/inria/repo/swh/swh-environment/swh-auth/docs'

Event Timeline

ardumont created this paste.Mar 25 2021, 4:53 PM
ardumont changed the title of this paste from sphinx-build -b html . _build/html ¯\_(ツ)_/¯ to swh-docs: make -C docs clean; make -C docs.Mar 25 2021, 4:58 PM
ardumont edited the content of this paste. (Show Details)
ardumont added a comment.Mar 25 2021, 5:09 PM

The module swh.web needs to be installed in the venv:

$ ipython
ipython        Python 3.7.3 (default, Apr  3 2019, 05:39:12)
Type 'copyright', 'credits' or 'license' for more information
IPython 7.20.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]: from swh.web.settings import development
---------------------------------------------------------------------------
ModuleNotFoundError                       Traceback (most recent call last)
<ipython-input-1-937eaf9dd74f> in <module>
----> 1 from swh.web.settings import development

ModuleNotFoundError: No module named 'swh.web.settings'

In [2]:
Do you really want to exit ([y]/n)? y

So:

$ cd ../swh-web;
$ pip install -e .

(or bin/install from swh-env but it's slow)

After that:

make -C docs clean; make -C docs

is ok.

About · Developer information · Legal