search

jazzband / help

Use this repo to get help from the roadies
https://jazzband.co/roadies
27 stars 7 forks source link

django-auditlog documentation issue #345

Closed hramezani closed 8 months ago

hramezani commented 8 months ago

django-auditlog documentation is outdated and it has not been updated for a long time. we don't have credentials for redthedocs. I am not very familiar with readthedocs and don't know how to fix the problem.

@jezdez could you please take a look and help?

hugovk commented 8 months ago

https://readthedocs.org/projects/django-auditlog/ is the project dashboard.

https://readthedocs.org/projects/django-auditlog/builds/ shows it is building as recently as 3 days ago, but there's an error:

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'

Here's a PR which should hopefully fix it: https://github.com/jazzband/django-auditlog/pull/578

It built successfully on my branch: