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

Replace readthedocs with Jupyter Book #2016

Closed
miguelgfierro opened this issue Oct 10, 2023 · 3 comments
Closed

Replace readthedocs with Jupyter Book #2016

miguelgfierro opened this issue Oct 10, 2023 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@miguelgfierro
Copy link
Collaborator

miguelgfierro commented Oct 10, 2023

Description

Documentation in readthedocs failing:

Running Sphinx v5.3.0
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
making output directory... done
WARNING: sphinx_rtd_theme (< 0.3.0) found. It will not be available since Sphinx-6.0

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/microsoft-recommenders/envs/latest/lib/python3.7/site-packages/sphinx/cmd/build.py", line 280, in build_main
    args.pdb)
  File "/home/docs/checkouts/readthedocs.org/user_builds/microsoft-recommenders/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 262, in __init__
    self._init_builder()
  File "/home/docs/checkouts/readthedocs.org/user_builds/microsoft-recommenders/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 334, in _init_builder
    self.builder.init()
  File "/home/docs/checkouts/readthedocs.org/user_builds/microsoft-recommenders/envs/latest/lib/python3.7/site-packages/sphinx/builders/html/__init__.py", line 248, in init
    self.init_templates()
  File "/home/docs/checkouts/readthedocs.org/user_builds/microsoft-recommenders/envs/latest/lib/python3.7/site-packages/sphinx/builders/html/__init__.py", line 299, in init_templates
    self.theme = theme_factory.create(themename)
  File "/home/docs/checkouts/readthedocs.org/user_builds/microsoft-recommenders/envs/latest/lib/python3.7/site-packages/sphinx/theming.py", line 241, in create
    raise ThemeError(__('no theme named %r found (missing theme.conf?)') % name)
sphinx.errors.ThemeError: no theme named 'sphinx_rtd_theme' found (missing theme.conf?)

Theme error:
no theme named 'sphinx_rtd_theme' found (missing theme.conf?)

Also, we need to upgrade build.os instead of build.image on your configuration file: https://blog.readthedocs.com/use-build-os-config/

In which platform does it happen?

How do we replicate the issue?

Expected behavior (i.e. solution)

Other Comments

It is probably better to move to Jupyter Book. See example: https://microsoft.github.io/genalog/

@miguelgfierro miguelgfierro added the bug Something isn't working label Oct 10, 2023
@miguelgfierro
Copy link
Collaborator Author

New error https://readthedocs.org/projects/microsoft-recommenders/builds/22533794/

Error
Problem in your project's configuration. Invalid configuration option "build.os": os not found

@miguelgfierro
Copy link
Collaborator Author

hey @laserprec @gramhagen, I think you once mentioned a nicer way to do the documentation. Not sure if it is jupyter book?

Anyway, any suggestion for the documentation of Recommenders?

@gramhagen
Copy link
Collaborator

yes, @laserprec has a great example using Jupyter Book here: https://microsoft.github.io/genalog/
for this repo: https://github.com/microsoft/genalog

@miguelgfierro miguelgfierro changed the title [BUG] Documentation in readthedocs failing Replace readthedocs with Jupyter Book Dec 5, 2023
@miguelgfierro miguelgfierro self-assigned this Dec 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants