Meta doc

Gitlab project

Issues

Pipelines

pyproject.toml

 1[tool.poetry]
 2name = "tuto_devops"
 3version = "0.1.0"
 4description = "Tuto devops"
 5authors = ["Noam <noamsw@pm.me>"]
 6
 7[tool.poetry.dependencies]
 8python = "^3.9"
 9sphinx-material = "*"
10sphinx-markdown-tables = "*"
11sphinx-copybutton = "*"
12sphinx-panels = "*"
13sphinx-tabs = "*"
14autoclasstoc = "*"
15Sphinx = "*"
16myst-parser = "*"
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
 20
 21# If extensions (or modules to document with autodoc) are in another directory,
 22# add these directories to sys.path here. If the directory is relative to the
 23# documentation root, use os.path.abspath to make it absolute, like shown here.
 24# sys.path.insert(0, os.path.abspath("./src"))
 25
 26project = "Tuto devops"
 27html_title = project
 28
 29author = f"DevOps people"
 30html_logo = "images/DevSecOps-security.png"
 31html_favicon = "images/DevSecOps-security.png"
 32release = "0.1.0"
 33now = datetime.now(tz=ZoneInfo("Europe/Paris"))
 34version = f"{now.year}-{now.month:02}-{now.day:02} {now.hour:02}H ({now.tzinfo})"
 35today = version
 36
 37extensions = [
 38    "sphinx.ext.autodoc",
 39    "sphinx.ext.doctest",
 40    "sphinx.ext.extlinks",
 41    "sphinx.ext.intersphinx",
 42    "sphinx.ext.todo",
 43    "sphinx.ext.mathjax",
 44    "sphinx.ext.viewcode",
 45    "myst_parser",
 46    "sphinx_markdown_tables",
 47    "sphinx_copybutton",
 48]
 49extensions += ["sphinx.ext.intersphinx"]
 50
 51autosummary_generate = True
 52autoclass_content = "class"
 53
 54# Add any paths that contain templates here, relative to this directory.
 55templates_path = ["_templates"]
 56exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 57html_static_path = ["_static"]
 58html_show_sourcelink = True
 59html_sidebars = {
 60    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
 61}
 62extensions.append("sphinx_material")
 63html_theme_path = sphinx_material.html_theme_path()
 64html_context = sphinx_material.get_html_context()
 65html_theme = "sphinx_material"
 66
 67extensions.append("sphinx.ext.intersphinx")
 68intersphinx_mapping = {
 69    "django": ("https://gdevops.gitlab.io/tuto_django/", None),
 70    "docker": ("https://gdevops.gitlab.io/tuto_docker/", None),
 71    "cli": ("https://gdevops.gitlab.io/tuto_cli/", None),
 72    "build": ("https://gdevops.gitlab.io/tuto_build/", None),
 73    "web": ("https://gdevops.gitlab.io/tuto_web/", None),
 74    "sphinx": ("https://www.sphinx-doc.org/en/master", None),
 75    "sphinx_material": ("https://gdevops.gitlab.io/tuto_sphinx_material", None),
 76}
 77extensions.append("sphinx.ext.todo")
 78todo_include_todos = True
 79
 80extensions += [
 81    "sphinx_panels",
 82]
 83extensions += ["sphinx_tabs.tabs"]
 84# Panels config
 85panels_add_bootstrap_css = False
 86
 87# autoclasstoc + napoleon + autodoc
 88# https://autoclasstoc.readthedocs.io/en/latest/basic_usage.html
 89extensions += [
 90    "autoclasstoc",
 91    "sphinx.ext.napoleon",
 92    "sphinx.ext.autodoc",
 93    "sphinx.ext.autosummary",
 94    "sphinx.ext.viewcode",
 95]
 96autodoc_default_options = {
 97    "members": True,
 98    "special-members": True,
 99    "private-members": True,
100    "inherited-members": True,
101    "undoc-members": True,
102    "exclude-members": "__weakref__",
103}
104
105# material theme options (see theme.conf for more information)
106# https://github.com/bashtage/sphinx-material/blob/master/sphinx_material/sphinx_material/theme.conf
107# Colors
108# The theme color for mobile browsers. Hex color.
109# theme_color = #3f51b5
110# Primary colors:
111# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
112# teal, green, light-green, lime, yellow, amber, orange, deep-orange,
113# brown, grey, blue-grey, white
114# Accent colors:
115# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
116# teal, green, light-green, lime, yellow, amber, orange, deep-orange
117# color_accent = blue
118# color_primary = blue-grey
119
120# material theme options (see theme.conf for more information)
121html_theme_options = {
122    "base_url": "https://gdevops.gitlab.io/tuto_devops/",
123    "repo_url": "https://gitlab.com/gdevops/tuto_devops/",
124    "repo_name": project,
125    "html_minify": False,
126    "html_prettify": True,
127    "css_minify": True,
128    "repo_type": "github",
129    "globaltoc_depth": -1,
130    "color_primary": "green",
131    "color_accent": "cyan",
132    "touch_icon": "images/cnt.jpg",
133    "theme_color": "#2196f3",
134    "master_doc": False,
135    "nav_links": [
136        {
137            "href": "genindex",
138            "internal": True,
139            "title": "Index",
140        },
141        {
142            "href": "https://gdevops.gitlab.io/tuto_sphinx_material/",
143            "internal": False,
144            "title": "Sphinx-material example",
145        },
146    ],
147    "heroes": {
148        "index": "Documentation devops",
149    },
150    "table_classes": ["plain"],
151}
152
153language = "en"
154html_last_updated_fmt = ""
155
156todo_include_todos = True
157# html_favicon = "images/favicon.ico"
158
159html_use_index = True
160html_domain_indices = True
161
162
163copyright = f"2018-{now.year}, {author} Built with sphinx {sphinx.__version__} Python {platform.python_version()}"

gitlab-ci.yaml

 1image: pvergain/python_git:3.9.6-slim-buster
 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.0.1
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: 21.7b0
45    hooks:
46    - id: black
47      language_version: python3.9
48
49  - repo: https://github.com/asottile/reorder_python_imports
50    rev: v2.6.0
51    hooks:
52      - id: reorder-python-imports
53
54  - repo: https://github.com/hadialqattan/pycln
55    rev: 0.0.4 # 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 updatetools"
22	@echo "- make update"
23	@echo " "
24
25
26check_all:
27	pre-commit run --all-files
28
29req:
30	poetry env info --path
31	poetry show --tree
32	poetry check
33	poetry export -f requirements.txt --without-hashes  > requirements.txt
34	cat requirements.txt
35
36update:
37	poetry update
38	@$(MAKE) -f $(THIS_MAKEFILE) req
39	git diff requirements.txt
40	pre-commit autoupdate
41
42updatetools:
43	pre-commit autoupdate
44	gitmoji --update
45	git status
46
47.PHONY: help Makefile
48
49# Catch-all target: route all unknown targets to Sphinx using the new
50# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
51%: Makefile
52	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)