Meta doc

Head project : tuto_devops

Gitlab project

Issues

Pipelines

.git/config

 1[init]
 2	defaultBranch = none
 3[fetch]
 4	recurseSubmodules = false
 5[core]
 6	repositoryformatversion = 0
 7	filemode = true
 8	bare = false
 9	logallrefupdates = true
10[remote "origin"]
11	url = https://gitlab-ci-token:v1eYyChF2HVxmDEFJe2C@gitlab.com/gdevops/tuto_django.git
12	fetch = +refs/heads/*:refs/remotes/origin/*

pyproject.toml

 1[tool.poetry]
 2name = "tuto_django"
 3version = "0.1.0"
 4description = "Tuto django"
 5authors = ["Noam <noamsw@pm.me>"]
 6
 7[tool.poetry.dependencies]
 8python = "^3.10"
 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 Django"
 27html_title = project
 28
 29author = "DevOps people"
 30html_logo = "images/django-logo-negative.png"
 31html_favicon = "images/django-logo-negative.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
 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    "django": (
 71        "http://docs.djangoproject.com/en/dev/",
 72        "http://docs.djangoproject.com/en/dev/_objects/",
 73    ),
 74    "python": ("https://gdevops.gitlab.io/tuto_python/", None),
 75    "https://gdevops.gitlab.io/tuto_databases/": None,
 76    "psycopg2": ("https://www.psycopg.org/docs/", None),
 77    "docker": ("https://gdevops.gitlab.io/tuto_docker/", None),
 78    "git": ("https://gdevops.gitlab.io/tuto_git/", None),
 79    "languages": ("https://gdevops.gitlab.io/tuto_languages/", None),
 80    "sysops": ("https://gdevops.gitlab.io/tuto_sysops/", None),
 81    "javascript": ("https://gdevops.gitlab.io/tuto_javascript/", None),
 82    "build": ("https://gdevops.gitlab.io/tuto_build/", None),
 83    "project": ("https://gdevops.gitlab.io/tuto_project/", None),
 84    "tuto_secops": ("https://gdevops.gitlab.io/tuto_secops/", None),
 85    "tuto_htmx": ("https://gdevops.gitlab.io/tuto_htmx/", None),
 86    "tuto_html": ("https://gdevops.gitlab.io/tuto_html/", None),
 87    "databases": ("https://gdevops.gitlab.io/tuto_databases/", None),
 88    "webframeworks": ("https://gdevops.gitlab.io/tuto_webframeworks/", None),
 89    "programming": ("https://gdevops.gitlab.io/tuto_programming/", None),
 90    "http": ("https://gdevops.gitlab.io/tuto_http/", None),
 91    "sphinx_material": ("https://gdevops.gitlab.io/tuto_sphinx_material", None),
 92}
 93extensions.append("sphinx.ext.todo")
 94todo_include_todos = True
 95
 96extensions += [
 97    "sphinx_panels",
 98]
 99extensions += ["sphinx_tabs.tabs"]
100# Panels config
101panels_add_bootstrap_css = False
102
103# autoclasstoc + napoleon + autodoc
104# https://autoclasstoc.readthedocs.io/en/latest/basic_usage.html
105extensions += [
106    "autoclasstoc",
107    "sphinx.ext.napoleon",
108    "sphinx.ext.autodoc",
109    "sphinx.ext.autosummary",
110    "sphinx.ext.viewcode",
111]
112autodoc_default_options = {
113    "members": True,
114    "special-members": True,
115    "private-members": True,
116    "inherited-members": True,
117    "undoc-members": True,
118    "exclude-members": "__weakref__",
119}
120
121# material theme options (see theme.conf for more information)
122# https://gitlab.com/bashtage/sphinx-material/blob/master/sphinx_material/sphinx_material/theme.conf
123# Colors
124# The theme color for mobile browsers. Hex color.
125# theme_color = #3f51b5
126# Primary colors:
127# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
128# teal, green, light-green, lime, yellow, amber, orange, deep-orange,
129# brown, grey, blue-grey, white
130# Accent colors:
131# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
132# teal, green, light-green, lime, yellow, amber, orange, deep-orange
133# color_accent = blue
134# color_primary = blue-grey
135
136# material theme options (see theme.conf for more information)
137html_theme_options = {
138    "base_url": "https://gdevops.gitlab.io/tuto_django/",
139    "repo_url": "https://gitlab.com/gdevops/tuto_django/",
140    "repo_name": project,
141    "html_minify": False,
142    "html_prettify": True,
143    "css_minify": True,
144    "repo_type": "gitlab",
145    "globaltoc_depth": -1,
146    "color_primary": "green",
147    "color_accent": "cyan",
148    "theme_color": "#2196f3",
149    "master_doc": False,
150    "nav_title": f"{project} ({today})",
151    "nav_links": [
152        {
153            "href": "genindex",
154            "internal": True,
155            "title": "Index",
156        },
157        {
158            "href": "https://awesomedjango.org/",
159            "internal": False,
160            "title": "Awsome Django",
161        },
162        {
163            "href": "https://gdevops.gitlab.io/tuto_htmx/",
164            "internal": False,
165            "title": "Tuto HTMX",
166        },
167        {
168            "href": "https://gdevops.gitlab.io/tuto_http/",
169            "internal": False,
170            "title": "Tuto HTTP",
171        },
172        {
173            "href": "https://gdevops.gitlab.io/tuto_devops/",
174            "internal": False,
175            "title": "Tuto devops",
176        },
177    ],
178    "heroes": {
179        "index": "Tuto Django",
180    },
181    "table_classes": ["plain"],
182}
183
184
185language = "en"
186html_last_updated_fmt = ""
187
188todo_include_todos = True
189
190html_use_index = True
191html_domain_indices = True
192
193
194copyright = f"2018-{now.year}, {author} Built with sphinx {sphinx.__version__} Python {platform.python_version()}"

gitlab-ci.yaml

 1image: python:3.10.4-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.2.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.3.0
45    hooks:
46    - id: black
47      language_version: python3.9
48
49  - repo: https://github.com/asottile/reorder_python_imports
50    rev: v3.1.0
51    hooks:
52      - id: reorder-python-imports
53
54  - repo: https://github.com/hadialqattan/pycln
55    rev: v1.3.3 # Possible releases: https://github.com/hadialqattan/pycln/tags
56    hooks:
57      - id: pycln
58        args: [--config=pyproject.toml]
59
60  - repo: https://github.com/rtts/djhtml
61    rev: v1.5.0
62    hooks:
63      - id: djhtml

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 "- make clearcache"
24	@echo " "
25
26clearcache:
27	poetry cache clear --all pypi
28
29
30check_all:
31	pre-commit run --all-files
32
33req:
34	poetry env info --path
35	poetry show --tree
36	poetry check
37	poetry export -f requirements.txt --without-hashes  > requirements.txt
38	cat requirements.txt
39
40update:
41	poetry update
42	@$(MAKE) -f $(THIS_MAKEFILE) req
43
44
45updatetools:
46	pre-commit autoupdate
47
48.PHONY: help Makefile
49
50# Catch-all target: route all unknown targets to Sphinx using the new
51# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
52%: Makefile
53	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)