Meta doc

Head project : tuto_devops

Gitlab project

Issues

Pipelines

pyproject.toml

 1[tool.poetry]
 2name = "tuto_programming"
 3version = "0.1.0"
 4description = "Tuto programming"
 5authors = ["Noam <noamsw@pm.me>"]
 6
 7[tool.poetry.dependencies]
 8python = "^3.11"
 9sphinx-material = "*"
10recommonmark = "*"
11sphinx-markdown-tables = "*"
12sphinx-copybutton = "*"
13sphinx-panels = "*"
14sphinx-tabs = "*"
15autoclasstoc = "*"
16Sphinx = "*"
17
18[tool.poetry.dev-dependencies]
19
20[build-system]
21requires = ["poetry-core>=1.0.0"]
22build-backend = "poetry.core.masonry.api"

conf.py

  1# Configuration file for the Sphinx documentation builder.
  2#
  3# This file only contains a selection of the most common options. For a full
  4# list see the documentation:
  5# http://www.sphinx-doc.org/en/master/config
  6# -- Path setup --------------------------------------------------------------
  7# If extensions (or modules to document with autodoc) are in another directory,
  8# add these directories to sys.path here. If the directory is relative to the
  9# documentation root, use os.path.abspath to make it absolute, like shown here.
 10#
 11# import os
 12# import sys
 13# sys.path.insert(0, os.path.abspath('.'))
 14import platform
 15from datetime import datetime
 16from zoneinfo import ZoneInfo
 17
 18import sphinx
 19import sphinx_material
 20from recommonmark.transform import AutoStructify
 21
 22
 23# If extensions (or modules to document with autodoc) are in another directory,
 24# add these directories to sys.path here. If the directory is relative to the
 25# documentation root, use os.path.abspath to make it absolute, like shown here.
 26# sys.path.insert(0, os.path.abspath("./src"))
 27
 28project = "Tuto programming"
 29html_title = project
 30
 31author = f"DevOps people"
 32html_logo = "images/katie_bouman.jpeg"
 33html_favicon = "images/katie_bouman.jpeg"
 34release = "0.1.0"
 35now = datetime.now(tz=ZoneInfo("Europe/Paris"))
 36version = f"{now.year}-{now.month:02}-{now.day:02} {now.hour:02}H ({now.tzinfo})"
 37today = version
 38
 39extensions = [
 40    "sphinx.ext.autodoc",
 41    "sphinx.ext.doctest",
 42    "sphinx.ext.extlinks",
 43    "sphinx.ext.intersphinx",
 44    "sphinx.ext.todo",
 45    "sphinx.ext.mathjax",
 46    "sphinx.ext.viewcode",
 47    "recommonmark",
 48    "sphinx_markdown_tables",
 49    "sphinx_copybutton",
 50]
 51extensions += ["sphinx.ext.intersphinx"]
 52
 53
 54autosummary_generate = True
 55autoclass_content = "class"
 56
 57# Add any paths that contain templates here, relative to this directory.
 58templates_path = ["_templates"]
 59exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 60html_static_path = ["_static"]
 61html_show_sourcelink = True
 62html_sidebars = {
 63    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
 64}
 65extensions.append("sphinx_material")
 66html_theme_path = sphinx_material.html_theme_path()
 67html_context = sphinx_material.get_html_context()
 68html_theme = "sphinx_material"
 69
 70extensions.append("sphinx.ext.intersphinx")
 71intersphinx_mapping = {
 72    "python": ("https://gdevops.gitlab.io/tuto_python/", None),
 73    "git": ("https://gdevops.gitlab.io/tuto_git/", None),
 74    "languages": ("https://gdevops.gitlab.io/tuto_languages/", None),
 75    "tuto_programming": ("https://gdevops.gitlab.io/tuto_programming/", None),
 76    "django": ("https://gdevops.gitlab.io/tuto_django/", None),
 77    "docker": ("https://gdevops.gitlab.io/tuto_docker/", None),
 78    "databases": ("https://gdevops.gitlab.io/tuto_databases/", None),
 79    "javascript": ("https://gdevops.gitlab.io/tuto_javascript/", None),
 80    "sphinx": ("https://www.sphinx-doc.org/en/master", None),
 81    "sphinx_material": ("https://gdevops.gitlab.io/tuto_sphinx_material", None),
 82}
 83extensions.append("sphinx.ext.todo")
 84todo_include_todos = True
 85
 86extensions += [
 87    "sphinx_panels",
 88]
 89extensions += ["sphinx_tabs.tabs"]
 90# Panels config
 91panels_add_bootstrap_css = False
 92
 93# autoclasstoc + napoleon + autodoc
 94# https://autoclasstoc.readthedocs.io/en/latest/basic_usage.html
 95extensions += [
 96    "autoclasstoc",
 97    "sphinx.ext.napoleon",
 98    "sphinx.ext.autodoc",
 99    "sphinx.ext.autosummary",
100    "sphinx.ext.viewcode",
101]
102autodoc_default_options = {
103    "members": True,
104    "special-members": True,
105    "private-members": True,
106    "inherited-members": True,
107    "undoc-members": True,
108    "exclude-members": "__weakref__",
109}
110
111# material theme options (see theme.conf for more information)
112# https://gitlab.com/bashtage/sphinx-material/blob/master/sphinx_material/sphinx_material/theme.conf
113# Colors
114# The theme color for mobile browsers. Hex color.
115# theme_color = #3f51b5
116# Primary colors:
117# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
118# teal, green, light-green, lime, yellow, amber, orange, deep-orange,
119# brown, grey, blue-grey, white
120# Accent colors:
121# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
122# teal, green, light-green, lime, yellow, amber, orange, deep-orange
123# color_accent = blue
124# color_primary = blue-grey
125
126# material theme options (see theme.conf for more information)
127html_theme_options = {
128    "base_url": "https://gdevops.gitlab.io/tuto_programming/",
129    "repo_url": "https://gitlab.com/gdevops/tuto_programming",
130    "repo_name": project,
131    "html_minify": False,
132    "html_prettify": True,
133    "css_minify": True,
134    "repo_type": "gitlab",
135    "globaltoc_depth": -1,
136    "color_primary": "green",
137    "color_accent": "cyan",
138    "theme_color": "#2196f3",
139    "nav_title": f"{project} ({today})",
140    "master_doc": False,
141    "nav_links": [
142        {
143            "href": "genindex",
144            "internal": True,
145            "title": "Index",
146        },
147        {
148            "href": "https://gdevops.gitlab.io/tuto_python",
149            "internal": False,
150            "title": "Tuto python",
151        },
152        {
153            "href": "https://gdevops.gitlab.io/tuto_devops/",
154            "internal": False,
155            "title": "Tutos devops",
156        },
157    ],
158    "heroes": {
159        "index": "Tuto programming",
160    },
161    "table_classes": ["plain"],
162}
163
164
165language = "en"
166html_last_updated_fmt = ""
167
168todo_include_todos = True
169
170html_use_index = True
171html_domain_indices = True
172
173
174# Enable eval_rst in markdown
175def setup(app):
176    app.add_config_value(
177        "recommonmark_config",
178        {"enable_math": True, "enable_inline_math": True, "enable_eval_rst": True},
179        True,
180    )
181    app.add_transform(AutoStructify)
182    app.add_object_type(
183        "confval",
184        "confval",
185        objname="configuration value",
186        indextemplate="pair: %s; configuration value",
187    )
188
189
190copyright = f"2018-{now.year}, {author} Built with sphinx {sphinx.__version__} Python {platform.python_version()}"

gitlab-ci.yaml

 1image: python:3.11.0rc2-slim-bullseye
 2
 3pages:
 4  script:
 5  - pip install -r requirements.txt
 6  - sphinx-build -d _build/doctrees . _build/html
 7  - mv _build/html public
 8  artifacts:
 9    paths:
10    - public
11  only:
12  - main

.pre-commit-config.yaml

 1---
 2
 3# .pre-commit-config.yaml
 4# ========================
 5#
 6# pre-commit clean
 7# pre-commit install
 8# pre-commit install-hooks
 9#
10# precommit hooks installation
11#
12# - pre-commit autoupdate
13#
14# - pre-commit run black
15#
16# continuous integration
17# ======================
18#
19# - pre-commit run --all-files
20#
21
22repos:
23  - repo: https://github.com/pre-commit/pre-commit-hooks
24    rev: v4.3.0
25    hooks:
26    - id: trailing-whitespace
27    - id: end-of-file-fixer
28    - id: check-yaml
29    - id: check-json
30    - id: fix-encoding-pragma
31      args: ['--remove']
32    - id: forbid-new-submodules
33    - id: mixed-line-ending
34      args: ['--fix=lf']
35      description: Forces to replace line ending by the UNIX 'lf' character.
36    # - id: pretty-format-json
37    #  args: ['--no-sort-keys']
38    - id: check-added-large-files
39      args: ['--maxkb=500']
40    - id: no-commit-to-branch
41      args: [--branch, staging]
42
43  - repo: https://github.com/ambv/black
44    rev: 22.8.0
45    hooks:
46    - id: black
47      language_version: python3.11
48
49  - repo: https://github.com/asottile/reorder_python_imports
50    rev: v3.8.3
51    hooks:
52      - id: reorder-python-imports
53
54  - repo: https://github.com/hadialqattan/pycln
55    rev: v2.1.1 # Possible releases: https://github.com/hadialqattan/pycln/tags
56    hooks:
57      - id: pycln
58        args: [--config=pyproject.toml]

Makefile

 1# Minimal makefile for Sphinx documentation
 2#
 3
 4# You can set these variables from the command line.
 5SPHINXOPTS    =
 6SPHINXBUILD   = sphinx-build
 7SPHINXPROJ    = Tutopython
 8SOURCEDIR     = .
 9BUILDDIR      = _build
10
11THIS_MAKEFILE := $(lastword $(MAKEFILE_LIST))
12
13# Put it first so that "make" without argument is like "make help".
14help:
15	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
16	@echo " "
17	@echo "Targets:"
18	@echo " "
19	@echo "- make check_all"
20	@echo "- make req"
21	@echo "- make update"
22	@echo "- make clearcache"
23	@echo " "
24
25clearcache:
26	poetry cache clear --all pypi
27
28
29check_all:
30	pre-commit run --all-files
31
32req:
33	poetry env info --path
34	poetry show --tree
35	poetry check
36	poetry export -f requirements.txt --without-hashes  > requirements.txt
37	cat requirements.txt
38
39update:
40	poetry update
41	@$(MAKE) -f $(THIS_MAKEFILE) req
42	pre-commit autoupdate
43
44
45.PHONY: help Makefile
46
47# Catch-all target: route all unknown targets to Sphinx using the new
48# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
49%: Makefile
50	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)