Html files compiled with sphinx do not contain documentation from some files. Example: in backend/fregepoc package, there are files settings.py and wsgi.py, both start with multi-line comments:
settings.py:
"""
Django settings for fregepoc project.
Generated by 'django-admin startproject' using Django 4.0.3.
For more information on this file, see
https://docs.djangoproject.com/en/4.0/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.0/ref/settings/
"""
wsgi.py:
"""
WSGI config for fregepoc project.
It exposes the WSGI callable as a module-level variable named ``application``.
For more information on this file, see
https://docs.djangoproject.com/en/4.0/howto/deployment/wsgi/
"""
However, generated html looks like this:
Files asgi.py and urls.py also contain comments which were ignored.
During generation of html files from rst files following warnings are displayed:
WARNING: html_static_path entry '_static' does not exist
and
WARNING: autodoc: failed to import module 'conftest' from module 'backend'; the following exception was raised:
No module named 'fregepoc'
WARNING: autodoc: failed to import module 'asgi' from module 'backend.fregepoc'; the following exception was raised:
No module named 'fregepoc'
WARNING: autodoc: failed to import module 'urls' from module 'backend.fregepoc'; the following exception was raised:
No module named 'fregepoc'
WARNING: autodoc: failed to import module 'wsgi' from module 'backend.fregepoc'; the following exception was raised:
No module named 'fregepoc'
This list of warnings is too long to copy-paste it here completely but it follows the same pattern, only names of skipped modules are different.
It seems that sphinx may be configured incorrectly but I don't enough knowledge of it to fix this problem.
Html files compiled with sphinx do not contain documentation from some files. Example: in backend/fregepoc package, there are files settings.py and wsgi.py, both start with multi-line comments:
settings.py:
wsgi.py:
However, generated html looks like this:
Files asgi.py and urls.py also contain comments which were ignored.
During generation of html files from rst files following warnings are displayed:
and
This list of warnings is too long to copy-paste it here completely but it follows the same pattern, only names of skipped modules are different. It seems that sphinx may be configured incorrectly but I don't enough knowledge of it to fix this problem.