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

Fix Read The Docs build #578

Merged
merged 1 commit into from
Oct 27, 2023
Merged

Fix Read The Docs build #578

merged 1 commit into from
Oct 27, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Oct 27, 2023

Fixes jazzband/help#345.

pip install . during the build to fix:

Running Sphinx v7.2.6

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/envs/latest/lib/python3.11/site-packages/sphinx/config.py", line 358, in eval_config_file
    exec(code, namespace)  # NoQA: S102
    ^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/checkouts/latest/docs/source/conf.py", line 13, in <module>
    from auditlog import __version__
ModuleNotFoundError: No module named 'auditlog'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 293, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 211, in __init__
    self.config = Config.read(self.confdir, confoverrides or {}, self.tags)
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/envs/latest/lib/python3.11/site-packages/sphinx/config.py", line 181, in read
    namespace = eval_config_file(filename, tags)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/envs/latest/lib/python3.11/site-packages/sphinx/config.py", line 371, in eval_config_file
    raise ConfigError(msg % traceback.format_exc()) from exc
sphinx.errors.ConfigError: There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/envs/latest/lib/python3.11/site-packages/sphinx/config.py", line 358, in eval_config_file
    exec(code, namespace)  # NoQA: S102
    ^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/checkouts/latest/docs/source/conf.py", line 13, in <module>
    from auditlog import __version__
ModuleNotFoundError: No module named 'auditlog'


Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/envs/latest/lib/python3.11/site-packages/sphinx/config.py", line 358, in eval_config_file
    exec(code, namespace)  # NoQA: S102
    ^^^^^^^^^^^^^^^^^^^^^
  File "/home/docs/checkouts/readthedocs.org/user_builds/django-auditlog/checkouts/latest/docs/source/conf.py", line 13, in <module>
    from auditlog import __version__
ModuleNotFoundError: No module named 'auditlog'

https://readthedocs.org/projects/django-auditlog/builds/22324726/

It built successfully on my branch:

@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

Merging #578 (9c0ea33) into master (6b7f4a7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #578   +/-   ##
=======================================
  Coverage   95.01%   95.01%           
=======================================
  Files          31       31           
  Lines        1004     1004           
=======================================
  Hits          954      954           
  Misses         50       50           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@hramezani
Copy link
Member

Thanks @hugovk for your quick reaction and fixing this.

@hramezani hramezani merged commit 2bf675f into jazzband:master Oct 27, 2023
7 checks passed
@hugovk
Copy link
Member Author

hugovk commented Oct 27, 2023

You're welcome! And back in action! 🚀 📚

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 this pull request may close these issues.

django-auditlog documentation issue
2 participants