Meta doc

Head project : tuto_devops

Gitlab project

Issues

Pipelines

pyproject.toml

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