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

Sphinx theme broken, intersphinx_mapping #475

Closed
GernotMaier opened this issue Jun 23, 2023 · 1 comment · Fixed by #476
Closed

Sphinx theme broken, intersphinx_mapping #475

GernotMaier opened this issue Jun 23, 2023 · 1 comment · Fixed by #476

Comments

@GernotMaier
Copy link
Contributor

To issues related to sphinx:

  1. make html does not work locally:
make html
Running Sphinx v7.0.1
[autosummary] generating autosummary for: applications.rst, auxiliary_files.rst, camera_efficiency.rst, configuration_module.rst, corsika.rst, data_model.rst, databases.rst, db_handler.rst, gammasim-tools-configuration.rst, getting_started.rst, ..., layout_array.rst, library.rst, mc_model.rst, psf_analysis.rst, ray_tracing.rst, sim_telarray.rst, simulation_software.rst, simulators.rst, util.rst, visualization.rst
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 24 source files that are out of date
updating environment: [new config] 24 added, 0 changed, 0 removed
reading sources... [100%] visualization
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [  4%] applications
Theme error:
An error happened in rendering the page applications.
Reason: UndefinedError("'style' is undefined")
make: *** [html] Error 2

Seems to be a known issue (see here). Not sure why it works in the github action.

  1. running sphinx gives the following warning:
WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated and will be removed in Sphinx 8. Update to the current format as described in the documentation. Hint: "intersphinx_mapping = {'<name>': ('https://docs.python.org/', None)}".https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping

Also something we probably want to fix.

@orelgueta
Copy link
Contributor

Looks like the former issue can be solved by forcing the use of Sphinx version < 7. Alternatively we can switch to a theme which is supported also in newer versions of Sphinx (might make more sense actually).

Haven't looked into the second issue yet.

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