Frequently used Commands
Django
Running tests:
Run with coverage run manage.py module_name
Create a superuser:
`python manage.py createsuperuser`.
Apply database migrations:
python manage.py migrate --settings=GlitchGuru.settings
Collect static files:
python manage.py collectstatic --noinput --settings=GlitchGuru.settings
Documentation
Write Documentation: Create .rst files in the source folder to write documentation content.
.. include:: path/to/your/file.rst
Create Table of Contents: In your .rst files, use directives like .. toctree:: to create a table of contents.
.. toctree:: :maxdepth: 2 :caption: Contents:
Cross-Reference: To link to other parts of the documentation, use :ref: or :doc: directives.
See :doc:`path/to/another/file`.
Build HTML Documentation:
make htmlLive Server:
sphinx-autobuild <source directory> <directory to generate output in>
Example:
sphinx-autobuild docs/source docs/_build/html
Then, access http://127.0.0.1:8000/ with your browser.
Feel free to provide feedback or contribute to this documentation by following our contribution guidelines.