Page MenuHomeSoftware Heritage
Create Task
Maniphest T1182

deposit: apidoc generation fails on settings.production module with traceback
Closed, MigratedEdits Locked
Actions

Description

when generating documentation for swh-deposit, the following unhandled traceback makes sphinx skip the module in title:

/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-deposit/docs/apidoc/swh.deposit.settings.rst:28: WARNING: autodoc: failed to import module 'swh.deposit.settings.production'; the following exception was raised:
Traceback (most recent call last):
  File "/home/zack/.local/lib/python3.6/site-packages/sphinx/ext/autodoc.py", line 658, in import_object
    __import__(self.modname)
  File "/home/zack/dati/projects/sw-heritage/git/swh-environment/swh-deposit/swh/deposit/settings/production.py", line 29, in <module>
    SECRET_KEY = private_conf['secret_key']
KeyError: 'secret_key'

Revisions and Commits

rDDEP Push deposit
rDDEP0de54036cf29 docs/Makefile: Excluding deposit settings from autodoc generation

Related Objects

Event Timeline

zack triaged this task as Normal priority.Sep 7 2018, 11:49 AM
zack created this task.
zack added a project: Documentation.
ardumont added a subscriber: ardumont.Sep 25 2018, 5:42 PM

m.o:

# Remove eventual installed configuration
rm -rf ~/.config/swh/deposit/
# run the main documentation makefile target
cd $SWH_ENVIRONMENT_HOME/swh-docs/docs && make html

I was not able to reproduce up until i removed the local configuration.
Now that will be somewhat better to aim for a fix ;)

Cheers,

ardumont added a comment.EditedSep 25 2018, 6:54 PM

I'm frustrated and i feel like ranting.

That django-sphinx hell stuff is annoying.
This setup is not supposed to be loaded.

In swh-deposit/docs/conf.py, we mention the necessary use of`swh.deposit.settings.development`, not the rest already...

There, done ranting!

Trying to make the thing work now.

ardumont mentioned this in rDDEP7cbc6cad61ae: docs: Fix autodoc generation problem.Sep 27 2018, 11:30 AM
ardumont mentioned this in D447: docs: Fix autodoc generation problem for deposit module.Sep 27 2018, 11:55 AM
ardumont closed this task as Resolved by committing rDDEP0de54036cf29: docs/Makefile: Excluding deposit settings from autodoc generation.Sep 28 2018, 3:39 PM
ardumont added a commit: rDDEP0de54036cf29: docs/Makefile: Excluding deposit settings from autodoc generation.
ardumont moved this task from Backlog to Archived on the SWORD deposit board.Nov 3 2020, 4:06 PM
gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 9:58 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal