Merge pull request #88 from alhyss/SYMBOLISATION

Catalogue de symboles HTML

.github/workflows/sphinx.yml

@@ -0,0 +1,25 @@
+name: Deploy Sphinx documentation to Pages
+
+# Runs on pushes targeting the default branch
+on:
+  push:
+    branches: [ "SYMBOLISATION" ]
+
+# Cancel any in-progress job or run
+# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@v3

__outils__/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

__outils__/docs/conf.py

@@ -0,0 +1,92 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Catalogue de symboles'
+copyright = "2023, Conseil national de l'information géolocalisée"
+author = "Groupe de travail Dématérialisation des documents d'urbanisme, sous-groupe Symbolisation"
+
+# The full version, including alpha/beta/rc tags
+release = 'v1.0-alpha'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.githubpages',
+    'myst_parser', # Markdown support
+    'sphinx.ext.autodoc',
+    'numpydoc' # NumPy support
+]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+templates_path = []
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'fr'
+
+# 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.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'pydata_sphinx_theme'
+
+html_theme_options = {
+    "icon_links": [
+        {
+            # Label for this link
+            "name": "GitHub",
+            # URL where the link will redirect
+            "url": "https://github.com/GT-CNIG-DDU-team/SG5-SYMBOLISATION",  # required
+            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
+            "icon": "fa-brands fa-square-github",
+            # The type of image to be used (see below for details)
+            "type": "fontawesome",
+        }
+   ]
+}
+
+# html_logo = ''
+
+html_favicon = './icons/favicon_marianne.png'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+html_static_path = []
+
+
+# -- Myst options -------------------------------------------------------------
+
+## Markdown support
+## See docs : https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
+
+myst_heading_anchors = 5
+

__outils__/docs/index.rst

@@ -0,0 +1,20 @@
+.. Documentation master file
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Catalogue de symboles
+=====================
+
+.. toctree::
+   :maxdepth: 2
+
+   psmv
+   plu
+
+
+Navigation
+==========
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

__outils__/docs/plu.rst

@@ -0,0 +1,7 @@
+Plans locaux d'urbanisme
+========================
+
+.. toctree::
+   :maxdepth: 4
+
+   ../../PLU/preconisations

__outils__/docs/psmv.rst

@@ -0,0 +1,7 @@
+Plans de sauvegarde et mise en valeur
+=====================================
+
+.. toctree::
+   :maxdepth: 4
+
+   ../../PSMV/preconisations

__outils__/docs/requirements.txt

@@ -0,0 +1,6 @@
+furo
+myst-parser
+pydata-sphinx-theme
+numpydoc
+psycopg2
+rdflib