3 Commits

Author SHA1 Message Date
Sunil Mohan Adapa
70742bfd91
doc/dev: Fix Django related errors with auto-documentation
Closes: #2405.

- When Django module is mocked, there are some cases where modules using django
can't be imported due to errors.

- To fix that, don't mock the django module and require django and related
Debian packages to be installed on the system generate developer documentation.

- Initialize django in Sphinx configuration to allow django modules to be
imported without errors.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2024-08-26 18:29:55 -04:00
Sunil Mohan Adapa
1dd40f5c7a
doc/dev: Include information on how to edit dev documentation
This also avoid the warning "README.rst: WARNING: document isn't included in any
toctree".

Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2020-02-16 18:22:14 -05:00
Joseph Nuthalapati
ad30321fac
doc: dev: Add instructions to setup developer documentation
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil: Package is python3-sphinx-autobuild and not python3-sphinx-autodoc]
[sunil: Add about section, reindent]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2019-11-09 17:10:49 -08:00