Skip to content

Commit

Permalink
docs: Add dynamic version for documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
oleksandr-bozbei-ew committed Dec 1, 2023
1 parent 51c2c0f commit f6e656e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,17 @@
project_dir = os.path.join(current_dir, "py_ocpi/")
# autoapi_dirs = [os.path.join(project_dir, 'modules/')]
sys.path.insert(0, os.path.abspath(current_dir))
sys.path.insert(0, os.path.abspath(project_dir))

from py_ocpi import __version__ # noqa

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "Extrawest OCPI"
copyright = "2023, Extrawest"
author = "Extrawest"
release = "2023.11.07"
release = f"{__version__}"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
2 changes: 2 additions & 0 deletions docs/source/tutorial/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,11 @@ The next step is to create `.env` file with otherwise the default values will be
- If set `True` urls in `{version}/details` will be returned with `/` in the end

.. warning::

It's strongly recommend to secure your endpoints with authentication. (`NO_AUTH = False`)

.. note::

As credentials module is built on top of credentials exchange,
`NO_AUTH` flag doesn't influence credentials module.

Expand Down

0 comments on commit f6e656e

Please sign in to comment.