Skip to content

Commit

Permalink
📝 [#43] Update documentation for setup-configuration
Browse files Browse the repository at this point in the history
to use directive provided by the library
  • Loading branch information
stevenbal committed Feb 7, 2025
1 parent cf7a891 commit b72e2ca
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 71 deletions.
15 changes: 14 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,17 @@
import os
import sys

import django
from django.utils.translation import activate

sys.path.insert(0, os.path.abspath("../src"))

import referentielijsten # noqa isort:skip

# from objects.setup import setup_env # noqa isort:skip
from referentielijsten.setup import setup_env # noqa isort:skip

setup_env()
django.setup()

# TODO: This needs to be enabled when we want to use autodoc to grab
# documentation from classes and functions. However, enabling django.setup()
Expand Down Expand Up @@ -42,6 +48,9 @@
# "sphinx_tabs.tabs",
# "recommonmark",
# "sphinx_markdown_tables",
"sphinx.ext.autodoc",
"django_setup_configuration.documentation.setup_config_example",
"django_setup_configuration.documentation.setup_config_usage",
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -54,6 +63,10 @@
# Usually you set "language" from the command line for these cases.
language = "en"

# Also set the language to English for Django, to make sure that any translatable text
# is also shown in English (for instance the help texts for setup configuration examples)
activate("en")

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ this.
:caption: Further reading

config
setup_configuraiton
setup_configuration
69 changes: 0 additions & 69 deletions docs/installation/setup_configuraiton.rst

This file was deleted.

7 changes: 7 additions & 0 deletions docs/installation/setup_configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. _installation_configuration_cli:

=====================================
Referentielijsten configuration (CLI)
=====================================

.. setup-config-usage::

0 comments on commit b72e2ca

Please sign in to comment.