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.

Sign up for GitHub

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

Jump to bottom

Build docs on ReadTheDocs again #7827

Closed
qstokkink opened this issue Jan 15, 2024 · 6 comments · Fixed by #8094 or #8095
Closed

Build docs on ReadTheDocs again #7827

qstokkink opened this issue Jan 15, 2024 · 6 comments · Fixed by #8094 or #8095
Labels
type: bug

Comments

@qstokkink
Copy link
Contributor

qstokkink commented Jan 15, 2024 •
edited
Loading

The build output is as follows:

Running Sphinx v4.3.0
INFO:root:Start to execute conf.py
INFO:root:Add source dir: /home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/src
INFO:root:Add source dir: /home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc
INFO:tribler.core.utilities.dependencies:Getting dependencies from: /home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/requirements-core.txt
INFO:root:Extract swagger for "restapi/swagger.yaml"
INFO:Tribler Config:Init. State dir: .. File: triblerd.conf
INFO:RESTComponent:__init__
INFO:ReporterComponent:__init__
INFO:Session:Starting components...
INFO:Session:State directory: "."
INFO:ReporterComponent:ReporterComponent: starting...
INFO:ReporterComponent:ReporterComponent: started in 0.0001s
INFO:RESTComponent:RESTComponent: starting...
INFO:RESTComponent:RESTComponent: waiting for ReporterComponent
INFO:RESTComponent:Adding: "/settings"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/shutdown"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/debug"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/downloads"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/createtorrent"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/statistics"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/libtorrent"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/torrentinfo"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/metadata"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/search"...
INFO:RESTComponent:OK
INFO:RESTComponent:Adding: "/knowledge"...
INFO:RESTComponent:OK
INFO:RESTManager:Starting RESTManager...
INFO:RESTManager:Remove head
/home/docs/checkouts/readthedocs.org/user_builds/tribler/envs/latest/lib/python3.8/site-packages/apispec/ext/marshmallow/common.py:139: UserWarning: Multiple schemas resolved to the name File. The name has been modified. Either manually add each of the schemas with a different name or provide a custom schema_name_resolver.
  warnings.warn(
INFO:RESTManager:Http enabled
INFO:RESTManager:Starting HTTP REST API server on port 8080...
INFO:RESTManager:HTTP REST API server started on port 8080
INFO:RESTManager:Swagger docs: http://127.0.0.1:8080/docs
INFO:RESTManager:Swagger JSON: http://127.0.0.1:8080/docs/swagger.json
INFO:RESTComponent:RESTComponent: started in 0.0363s
INFO:Session:All components started in 0.037 seconds
INFO:aiohttp.access:<Mock name='mock.get_extra_info()' id='140057665998176'> [15/Jan/2024:15:25:59 +0000] "GET /docs/swagger.json HTTP/1.1" 200 32632 "-" "-"
INFO:root:Proto has been started.
INFO:root:Response size: 32632
INFO:Session:Stopping components
INFO:ReporterComponent:ReporterComponent: Stopping ReporterComponent: waiting for ['RESTComponent'] to release it
INFO:RESTComponent:RESTComponent: Stopping RESTComponent: waiting for [] to release it
INFO:RESTComponent:RESTComponent: shutting down
INFO:RESTManager:Stopping...
INFO:RESTManager:Stopped
INFO:RESTComponent:RESTComponent: shut down
INFO:RESTComponent:Component RESTComponent, stopped. Remaining components: ['ReporterComponent']
INFO:ReporterComponent:ReporterComponent: shutting down
INFO:ReporterComponent:ReporterComponent: shut down
INFO:ReporterComponent:Component ReporterComponent, stopped. Remaining components: []
INFO:Session:All components are stopped
loading translations [en]... done
making output directory... done
[autosummary] generating autosummary for: building/building.rst, building/building_on_osx.rst, building/building_on_windows.rst, contributing.rst, development/development.rst, development/development_on_linux.rst, development/development_on_osx.rst, development/development_on_windows.rst, development/qt.rst, development_methodology.rst, ..., restapi/libtorrent.rst, restapi/metadata.rst, restapi/search.rst, restapi/settings.rst, restapi/shutdown.rst, restapi/state.rst, restapi/statistics.rst, restapi/torrentinfo.rst, restapi/trustview.rst, restapi/upgrader.rst
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 30 source files that are out of date
updating environment: [new config] 30 added, 0 changed, 0 removed
reading sources... [  3%] building/building
reading sources... [  6%] building/building_on_osx
reading sources... [ 10%] building/building_on_windows
reading sources... [ 13%] contributing
reading sources... [ 16%] development/development
reading sources... [ 20%] development/development_on_linux
reading sources... [ 23%] development/development_on_osx
reading sources... [ 26%] development/development_on_windows
reading sources... [ 30%] development/qt
reading sources... [ 33%] development_methodology
reading sources... [ 36%] index
reading sources... [ 40%] introduction
reading sources... [ 43%] metadata_store/channel_torrent_storage_format
reading sources... [ 46%] metadata_store/channels_architecture
reading sources... [ 50%] metadata_store/serialization_format
reading sources... [ 53%] restapi/createtorrent
reading sources... [ 56%] restapi/debug
reading sources... [ 60%] restapi/downloads
reading sources... [ 63%] restapi/events
reading sources... [ 66%] restapi/introduction
reading sources... [ 70%] restapi/libtorrent
reading sources... [ 73%] restapi/metadata
reading sources... [ 76%] restapi/search
reading sources... [ 80%] restapi/settings
reading sources... [ 83%] restapi/shutdown
reading sources... [ 86%] restapi/state
reading sources... [ 90%] restapi/statistics
reading sources... [ 93%] restapi/torrentinfo
reading sources... [ 96%] restapi/trustview
reading sources... [100%] restapi/upgrader

building/building_on_windows.rst:46: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 3 supplied.

.. code-block:: bash
    cd tribler

    python -m pip install -r requirements-build.txt

    python build\update_version.py 64
    python build\win\replace_nsi.py -r . --architecture x64

    build\win\makedist_win.bat
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/building/building.rst:3: WARNING: Duplicate explicit target name: "here".
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/building/building.rst:3: WARNING: Duplicate explicit target name: "here".
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/building/building_on_windows.rst:46: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 3 supplied.

.. code-block:: bash
    cd tribler

    python -m pip install -r requirements-build.txt

    python build\update_version.py 64
    python build\win\replace_nsi.py -r . --architecture x64

    build\win\makedist_win.bat
development/development_on_windows.rst:9: WARNING: Title underline too short.

Prerequisites
------------
development/development_on_windows.rst:9: WARNING: Title underline too short.

Prerequisites
------------
development/development_on_windows.rst:20: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 6 supplied.

.. code-block:: bash
    pip install --upgrade -r requirements.txt
development/development_on_windows.rst:28: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 4 supplied.

.. code-block:: bash
    cd src
    tribler.bat
development/development_on_osx.rst:65: WARNING: Title underline too short.

Apple Silicon
-------
development/development_on_osx.rst:65: WARNING: Title underline too short.

Apple Silicon
-------
development/development_on_osx.rst:71: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 7 supplied.

.. code-block:: bash
    brew install openssl boost boost-build boost-python3
development/development_on_linux.rst:36: WARNING: Title underline too short.

Fedora/CentOS/RedHat
------------------
development/development_on_linux.rst:36: WARNING: Title underline too short.

Fedora/CentOS/RedHat
------------------
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_linux.rst:36: WARNING: Title underline too short.

Fedora/CentOS/RedHat
------------------
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_linux.rst:36: WARNING: Title underline too short.

Fedora/CentOS/RedHat
------------------
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_osx.rst:65: WARNING: Title underline too short.

Apple Silicon
-------
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_osx.rst:65: WARNING: Title underline too short.

Apple Silicon
-------
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_osx.rst:71: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 7 supplied.

.. code-block:: bash
    brew install openssl boost boost-build boost-python3
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_windows.rst:9: WARNING: Title underline too short.

Prerequisites
------------
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_windows.rst:9: WARNING: Title underline too short.

Prerequisites
------------
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_windows.rst:20: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 6 supplied.

.. code-block:: bash
    pip install --upgrade -r requirements.txt
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/development/development_on_windows.rst:28: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 4 supplied.

.. code-block:: bash
    cd src
    tribler.bat
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/index.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
../README.rst:3: WARNING: Duplicate explicit target name: "linux".
../README.rst:3: WARNING: Duplicate explicit target name: "windows".
../README.rst:3: WARNING: Duplicate explicit target name: "macos".
/home/docs/checkouts/readthedocs.org/user_builds/tribler/checkouts/latest/doc/restapi/introduction.rst:57: WARNING: Malformed table.

+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| ALLOCATING_DISKSPACE  | Libtorrent is allocating disk space for the download                                                                   |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| WAITING_FOR_HASHCHECK | The download is waiting for the hash check to be performed                                                             |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| HASHCHECKING          | Libtorrent is checking the hashes of the download                                                                      |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| DOWNLOADING           | The torrent is being downloaded                                                                                        |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| SEEDING               | The torrent has been downloaded and is now being seeded to other peers                                                 |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| STOPPED               | The torrent has stopped downloading, either because the downloading has completed or the user has stopped the download |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| STOPPED_ON_ERROR      | The torrent has stopped because an error occurred                                                                      |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| METADATA              | The torrent information is being fetched from the DHT                                                                  |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
| CIRCUITS              | The (anonymous) download is building circuits                                                                          |
+-------------------------------+------------------------------------------------------------------------------------------------------------------------+
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [  3%] building/building
writing output... [  6%] building/building_on_osx
writing output... [ 10%] building/building_on_windows
writing output... [ 13%] contributing
writing output... [ 16%] development/development
writing output... [ 20%] development/development_on_linux
writing output... [ 23%] development/development_on_osx
writing output... [ 26%] development/development_on_windows
writing output... [ 30%] development/qt
writing output... [ 33%] development_methodology
writing output... [ 36%] index
writing output... [ 40%] introduction
writing output... [ 43%] metadata_store/channel_torrent_storage_format
writing output... [ 46%] metadata_store/channels_architecture
writing output... [ 50%] metadata_store/serialization_format
writing output... [ 53%] restapi/createtorrent
writing output... [ 56%] restapi/debug
writing output... [ 60%] restapi/downloads
writing output... [ 63%] restapi/events
writing output... [ 66%] restapi/introduction
writing output... [ 70%] restapi/libtorrent
writing output... [ 73%] restapi/metadata
writing output... [ 76%] restapi/search
writing output... [ 80%] restapi/settings
writing output... [ 83%] restapi/shutdown
writing output... [ 86%] restapi/state
writing output... [ 90%] restapi/statistics
writing output... [ 93%] restapi/torrentinfo
writing output... [ 96%] restapi/trustview
writing output... [100%] restapi/upgrader

generating indices... genindex http-routingtable done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 27 warnings.

The HTML pages are in ../_readthedocs/html.
Updating searchtools for Read the Docs search...

As an example, the table that is referred to by the warning above does not show up either in GitHub or ReadTheDocs:

Secondly, autodoc is broken. The "Module Index", linked to on the main page, does not exist: https://tribler.readthedocs.io/en/latest/py-modindex.html

Lastly, there are a few branch builds for branches that haven't existed for years (like the next branch): https://readthedocs.org/projects/tribler/
@qstokkink
Copy link
Contributor Author

The docs are now fixed BUT the ReadTheDocs build for Tribler has not run in 6 months now. We'll have to seize control of the RTD project again to get it to build.

@qstokkink qstokkink changed the title Documentation (ReadTheDocs + GitHub) is silently failing Build docs on ReadTheDocs again Aug 12, 2024
@qstokkink
Copy link
Contributor Author

qstokkink commented Aug 12, 2024 •
edited
Loading

Looking at our webhooks, it seems our ReadTheDocs webhook is broken. I removed the failing hook for the time being.

@qstokkink
Copy link
Contributor Author

I resynced the webhook. The hook is now working but the build is failing with The required .readthedocs.yaml configuration file was not found at repository's root.

@qstokkink qstokkink mentioned this issue Aug 19, 2024
Merged
@qstokkink
Copy link
Contributor Author

A new error popped up: ERROR: Could not open requirements file: [Errno 2] No such file or directory: 'pyipv8/requirements.txt'

Apparently we need to force RTD to checkout submodules.

@qstokkink qstokkink reopened this Aug 19, 2024
@qstokkink qstokkink mentioned this issue Aug 20, 2024
Merged
@qstokkink
Copy link
Contributor Author

We're back: https://tribler.readthedocs.io/en/latest/

@qstokkink
Copy link
Contributor Author

https://tribler.readthedocs.io/en/latest/building/linux.html these instructions are out of date now though.. but that is a separate issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: bug
Milestone
No milestone
1 participant
@qstokkink