django-cookie-consent icon indicating copy to clipboard operation
django-cookie-consent copied to clipboard

Docs have blank sections

Open 9mido opened this issue 4 years ago • 3 comments

The API documentation section is blank in the docs. Is that because these things are planned and are not available yet?

https://django-cookie-consent.readthedocs.io/en/latest/api_models.html

https://django-cookie-consent.readthedocs.io/en/latest/api_views.html

https://django-cookie-consent.readthedocs.io/en/latest/api_util.html

https://django-cookie-consent.readthedocs.io/en/latest/api_templatetags.html

https://django-cookie-consent.readthedocs.io/en/latest/api_middleware.html

9mido avatar May 07 '20 01:05 9mido

@9mido no, I guess that there is some misconfiguration. PR would be welcomed :)

bmihelac avatar May 07 '20 06:05 bmihelac

@bmihelac I am not much of a programmer I am more of a bug finder so I wouldn't have much insight into making a PR for this. Hopefully someone else could though!

9mido avatar May 15 '20 14:05 9mido

If anyone knows how to read/write restructured text language or use sphinx then that would help resolve this issue.

This seems to work if I do this:

Download a zip file of django-cookie-consent

cd ~/downloads/django-cookie-consent-master/docs
sudo apt install sphinx-doc sphinx-common
pip install django-appconf
make html

Inside of docs conf.py:

import django
#we need to link the cookie_consent app folder because it is currently not in conf.py
sys.path.insert(0, os.path.abspath(os.path.join('..', '..', 'cookie_consent')))
os.environ['DJANGO_SETTINGS_MODULE'] = 'settings'
django.setup()

I am thinking the docs comments containing the information about that API should not really be in the python files themselves and instead should be in the rst files. But I am happy for now that the docs are no longer showing blank pages.

html_static_path = ['_static'] produces a warning WARNING: html_static_path entry '_static' does not exist so maybe we could have instead html_static_path = []

some1ataplace avatar Mar 04 '22 01:03 some1ataplace