Documentation sphink skeleton

hitier
1 parent f9f61c77
Showing 9 changed files with 192 additions and 28 deletions Show diff stats
.gitignore
INSTALL.md
docs/Makefile
docs/README.md
docs/conf.py
docs/glossary.rst
docs/index.rst
docs/installation.rst
docs/pdc-web-INSTALL.md
@@ -6,3 +6,6 @@ pdc_config.py
 .flaskenv
 *.xml
 .coverage
+_build
+_static
+_templates
-make venv && source activate && pip -r requi..
-picharm requirement
-run with pycharm
-run with apache+wsgi
-run with nginx+uwsgi
-run through docker
-install standalone on your own server
-update your server installation
-ress/flaskenv > .flaskenv
-run tests
-PYTHONPATH=. pytest  --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" 
-
-install
--------
-
-make working dir: 
+# install
+
+## make working dir: 
  
     mkdir /path/to/working-directory
     git --work-tree=/path/to/working-directory --git-dir=/path/to/the/repo.git checkout -f master
  
-set environment
+## set environment
  
     python3 -m venv venv
     source venv/bin/activate
@@ -26,8 +13,7 @@ set environment
     cp resources/pdc_config.py .
     $(EDITOR) pdc_config.py
  
-git autodeploy
---------------
+## git autodeploy
  
     # make bare repo
     git clone --bare /path/to/the/repo.git
@@ -37,18 +23,31 @@ git autodeploy
  
     git push to repo
  
-configure apache 
-----------------
+## configure apache 
  
     cp ./resources/apache2-virtual-host.conf /etc/apache2/sites-available/pdc-web.conf
     $(EDITOR) /etc/apache2/sites-available/pdc-web.conf # set parameters
     $(EDITOR) /etc/hosts # to add your hostname if local install
     apachectl restart
  
-virtual-apage.conf
-pdc_web.py
-pdc_web.wsgi
-.flaskenv
-post-deploy.sh
-git-hook
-git bare repo
+## To Include in install procedures
+
+- virtual-apage.conf
+- pdc_web.py
+- pdc_web.wsgi
+- .flaskenv
+- post-deploy.sh
+- git-hook
+- git bare repo
+- make venv && source activate && pip -r requi..
+- picharm requirement
+- run with pycharm
+- run with apache+wsgi
+- run with nginx+uwsgi
+- run through docker
+- install standalone on your own server
+- update your server installation
+- ress/flaskenv > .flaskenv
+- run tests
+- PYTHONPATH=. pytest  --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" 
+
@@ -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)
@@ -0,0 +1,16 @@
+# Documentation PlanDeCharge
+
+Ce répertoire héberge les source de la  documentation sphinx du projet et les fichier pour la construire.
+
+## Prérequis
+
+    sudo apt-get install latexmk texlive-latex-extra # (pour les outils latexpdf )
+    source ../venv/bin/activate
+    pip install -r ../requirements-docs.txt
+
+
+## Générer la documentation
+
+
+    # construire la documentation dans _build/latex/plandecharge.pdf
+    make latexpdf
@@ -0,0 +1,76 @@
+# 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.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+#20210216 rhi: allow md parsing and autostructify
+import recommonmark
+from recommonmark.parser import CommonMarkParser
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Plan de Charge'
+copyright = '2021, Richard Hitier'
+author = 'Richard Hitier'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- 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.autodoc']
+extensions = ['recommonmark']
+
+
+
+#20210216 rhi: addings for markdown inclusion support
+source_suffix = ['.rst', '.md']
+source_parsers = {
+           '.md': CommonMarkParser,
+           }
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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 = 'alabaster'
+
+# 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']
+
@@ -0,0 +1,13 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+
+    plan de charge
+        Pourcentage d'implication des agents par projets sur une période de temps.
+
+    ETP
+        Équivalent temps plein.
+
@@ -0,0 +1,27 @@
+.. Plan de Charge documentation master file, created by
+   sphinx-quickstart on Tue Feb 16 15:07:36 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Bienvenue dans la documentation Plan de Charge
+==============================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+
+   glossary
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+* :ref:`glossary`
@@ -0,0 +1,9 @@
+************
+Installation
+************
+
+.. toctree::
+   :maxdepth: 2
+
+   README
+   pdc-web-INSTALL
@@ -0,0 +1 @@
+../INSTALL.md
 \ No newline at end of file