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

Theme is not showing up in the RTD build documentation #11876

Open
miroi opened this issue Dec 25, 2024 · 5 comments
Open

Theme is not showing up in the RTD build documentation #11876

miroi opened this issue Dec 25, 2024 · 5 comments
Labels
Support Support question

Comments

@miroi
Copy link

miroi commented Dec 25, 2024

Hello,

this is my RTD documentation https://diracprogram-documentation.readthedocs.io/en/latest/
(from https://readthedocs.org/projects/diracprogram-documentation/builds/26684900/ )

but the theme is not showing up. It has to be the like https://diracprogram.org/doc/master/ .

The log file gives no warning/error for "make VERBOSE=1 html" documentation generation.

Here is the doc/conf.py file https://gitlab.com/dirac/dirac/-/blob/master/doc/conf.py?ref_type=heads .

Any help why on RTD server the documentation is not built properly ? On my local PC, and our remote documentation server https://diracprogram.org/doc/master/ the build is fine wrt to the theme.

@humitos humitos added the Support Support question label Jan 2, 2025
@humitos
Copy link
Member

humitos commented Jan 2, 2025

It seems that you are encapsulating the Sphinx commands under ./setup and make commands, which makes debugging really hard since there is no Sphinx output that we can take a look.

@miroi
Copy link
Author

miroi commented Jan 4, 2025

Hello @humitos ,

thanks for your hint.

I inserted verbose flag into the sphinx build (see https://gitlab.com/dirac/dirac/-/merge_requests/208/diffs ) , the full output is here, https://readthedocs.org/api/v2/build/26743967.txt . I do not see any warning/error concerning missing the theme/css in the generated documentation https://diracprogram-documentation.readthedocs.io/en/latest/ .

I have (almost) the same raw output for my local computer documentation buildup.

The difference is in installed pip packages, this is my local WSL-Ubuntu list :

(venv) miroi@MiroPhenomII-X6:~/software/.pip list
Package                       Version
----------------------------- -----------
alabaster                     0.7.16
ase                           3.24.0
babel                         2.16.0
certifi                       2024.12.14
charset-normalizer            3.4.1
contourpy                     1.3.1
cycler                        0.12.1
docutils                      0.19
fonttools                     4.55.3
idna                          3.10
imagesize                     1.4.1
Jinja2                        3.1.5
kiwisolver                    1.4.8
latexcodec                    3.0.0
MarkupSafe                    3.0.2
matplotlib                    3.10.0
numpy                         2.2.1
packaging                     24.2
pillow                        11.0.0
pip                           24.0
pybtex                        0.24.0
pybtex-docutils               1.0.3
Pygments                      2.18.0
pyparsing                     3.2.0
python-dateutil               2.9.0.post0
PyYAML                        6.0.2
requests                      2.32.3
ruff                          0.8.5
scipy                         1.14.1
setuptools                    75.6.0
six                           1.17.0
snowballstemmer               2.2.0
Sphinx                        6.2.1
sphinx-rtd-theme              3.0.2
sphinxcontrib-applehelp       2.0.0
sphinxcontrib-bibtex          2.5.0
sphinxcontrib-devhelp         2.0.0
sphinxcontrib-htmlhelp        2.1.0
sphinxcontrib-jquery          4.1
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-qthelp          2.0.0
sphinxcontrib-serializinghtml 2.0.0
urllib3                       2.3.0
(venv) miroi@MiroPhenomII-X6:~/software/.lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 24.04.1 LTS
Release:        24.04
Codename:       noble
(venv) miroi@MiroPhenomII-X6:~/software/.

and this the pip list is on the RTD server side (from https://readthedocs.org/projects/diracprogram-documentation/builds/26743967/ ):

pip list
Package                       Version
----------------------------- ----------
alabaster                     0.7.16
babel                         2.16.0
certifi                       2024.12.14
charset-normalizer            3.4.1
docutils                      0.19
idna                          3.10
imagesize                     1.4.1
Jinja2                        3.1.5
latexcodec                    3.0.0
MarkupSafe                    3.0.2
packaging                     24.2
pip                           23.1
pybtex                        0.24.0
pybtex-docutils               1.0.3
Pygments                      2.18.0
PyYAML                        6.0.2
requests                      2.32.3
setuptools                    67.6.1
six                           1.17.0
snowballstemmer               2.2.0
Sphinx                        6.2.1
sphinx-rtd-theme              3.0.2
sphinxcontrib-applehelp       2.0.0
sphinxcontrib-bibtex          2.5.0
sphinxcontrib-devhelp         2.0.0
sphinxcontrib-htmlhelp        2.1.0
sphinxcontrib-jquery          4.1
sphinxcontrib-jsmath          1.0.1
sphinxcontrib-qthelp          2.0.0
sphinxcontrib-serializinghtml 2.0.0
urllib3                       2.3.0
wheel                         0.40.0

@humitos
Copy link
Member

humitos commented Jan 7, 2025

That's weird. I took a quick look at the log from Read the Docs you shared and I'm not seeing anything obvious. Inspecting the HTML, it's clear that there CSS and JS files are not included there and that's why it's not loading the theme.

@humitos
Copy link
Member

humitos commented Jan 7, 2025

I think I found the issue, you can't "activate a venv" like this . venv/bin/activate on Read the Docs.

@miroi
Copy link
Author

miroi commented Jan 7, 2025

think I found the issue, you can't "activate a venv" like this . venv/bin/activate on Read the Do

Thanks for your hint, @humitos .

But I need the "venv" environment, based on https://diracprogram.org/doc/master/development/documentation_howto.html#sphinx-installation .

I tried source venv/bin/activate, but source command was lacking at the RTD server.

Any help on how to activate venv on RTD ?

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

No branches or pull requests

2 participants