Meta

Gitlab project

Issues

Pipelines

Git config

Git config gitlab

[init]
	defaultBranch = none
[fetch]
	recurseSubmodules = false
[core]
	repositoryformatversion = 0
	filemode = true
	bare = false
	logallrefupdates = true
[remote "origin"]
	url = https://gitlab-ci-token:egxc4H7jQUAdXtaWsCxS@gitlab.com/gdevops/tuto_htmx.git
	fetch = +refs/heads/*:refs/remotes/origin/*

Git config local

[core]
    repositoryformatversion = 0
    filemode = true
    bare = false
    logallrefupdates = true
[remote "origin"]
    url = git@gitlab.com:gdevops/tuto_htmx.git
    fetch = +refs/heads/*:refs/remotes/origin/*
[branch "master"]
    remote = origin
    merge = refs/heads/master
[user]
    name = Aaron
    email = swaaron@pm.me
[alias]
    dlog = log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit
    ci = commit
    co = chekout
    st = status

pyproject.toml

 1[tool.poetry]
 2name = "tuto_htmx"
 3version = "0.1.0"
 4description = "Tuto htmx"
 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# 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
 26
 27project = "Tuto htmx"
 28html_title = project
 29
 30author = f"DevOps people"
 31html_logo = "images/logo/white_blackbg.png"
 32html_favicon = "images/logo/white_blackbg.png"
 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    "myst_parser",
 47    "sphinx_copybutton",
 48]
 49autosummary_generate = True
 50autoclass_content = "class"
 51
 52# Add any paths that contain templates here, relative to this directory.
 53templates_path = ["_templates"]
 54exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "github"]
 55html_static_path = ["_static"]
 56html_show_sourcelink = True
 57html_sidebars = {
 58    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
 59}
 60extensions.append("sphinx_material")
 61html_theme_path = sphinx_material.html_theme_path()
 62html_context = sphinx_material.get_html_context()
 63html_theme = "sphinx_material"
 64
 65extensions.append("sphinx.ext.intersphinx")
 66intersphinx_mapping = {
 67    "docker": ("https://gdevops.gitlab.io/tuto_docker/", None),
 68    "tuto_django": ("https://gdevops.gitlab.io/tuto_django/", None),
 69    "tuto_hyperscript": ("https://gdevops.gitlab.io/tuto_hyperscript/", None),
 70    "tuto_html": ("https://gdevops.gitlab.io/tuto_html/", None),
 71    "documentation": ("https://gdevops.gitlab.io/tuto_documentation/", None),
 72    "http": ("https://gdevops.gitlab.io/tuto_http/", None),
 73    "tuto_webframeworks": ("https://gdevops.gitlab.io/tuto_webframeworks/", None),
 74    "project": ("https://gdevops.gitlab.io/tuto_project/", None),
 75    "sphinx": ("https://www.sphinx-doc.org/en/master", None),
 76    "sphinx_material": ("https://gdevops.gitlab.io/tuto_sphinx_material", None),
 77    "til_2021": ("https://gdevops.gitlab.io/til_2021/", None),
 78}
 79extensions.append("sphinx.ext.todo")
 80todo_include_todos = True
 81
 82extensions += [
 83    "sphinx_panels",
 84]
 85extensions += ["sphinx_tabs.tabs"]
 86# Panels config
 87panels_add_bootstrap_css = False
 88
 89# autoclasstoc + napoleon + autodoc
 90# https://autoclasstoc.readthedocs.io/en/latest/basic_usage.html
 91extensions += [
 92    "autoclasstoc",
 93    "sphinx.ext.napoleon",
 94    "sphinx.ext.autodoc",
 95    "sphinx.ext.autosummary",
 96    "sphinx.ext.viewcode",
 97]
 98autodoc_default_options = {
 99    "members": True,
100    "special-members": True,
101    "private-members": True,
102    "inherited-members": True,
103    "undoc-members": True,
104    "exclude-members": "__weakref__",
105}
106
107# material theme options (see theme.conf for more information)
108# https://gitlab.com/bashtage/sphinx-material/blob/master/sphinx_material/sphinx_material/theme.conf
109# Colors
110# The theme color for mobile browsers. Hex color.
111# theme_color = #3f51b5
112# Primary colors:
113# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
114# teal, green, light-green, lime, yellow, amber, orange, deep-orange,
115# brown, grey, blue-grey, white
116# Accent colors:
117# red, pink, purple, deep-purple, indigo, blue, light-blue, cyan,
118# teal, green, light-green, lime, yellow, amber, orange, deep-orange
119# color_accent = blue
120# color_primary = blue-grey
121
122# material theme options (see theme.conf for more information)
123html_theme_options = {
124    "base_url": "https://gdevops.gitlab.io/tuto_htmx/",
125    "repo_url": "https://gitlab.com/gdevops/tuto_htmx",
126    "repo_name": project,
127    "html_minify": False,
128    "html_prettify": True,
129    "css_minify": True,
130    "repo_type": "gitlab",
131    "globaltoc_depth": -1,
132    "color_primary": "green",
133    "color_accent": "cyan",
134    "theme_color": "#2196f3",
135    "nav_title": f"{project} ({today})",
136    "master_doc": False,
137    "nav_links": [
138        {
139            "href": "genindex",
140            "internal": True,
141            "title": "Index",
142        },
143        {
144            "href": "https://htmx.org/",
145            "internal": False,
146            "title": "htmx",
147        },
148        {
149            "href": "https://gdevops.gitlab.io/tuto_html/",
150            "internal": False,
151            "title": "Tuto HTML",
152        },
153        {
154            "href": "https://gdevops.gitlab.io/tuto_hyperscript/",
155            "internal": False,
156            "title": "Tuto hyperscript",
157        },
158        {
159            "href": "https://gdevops.gitlab.io/tuto_django/",
160            "internal": False,
161            "title": "Tuto Django",
162        },
163    ],
164    "heroes": {
165        "index": "Tuto htmx",
166    },
167    "table_classes": ["plain"],
168}
169
170
171language = "en"
172html_last_updated_fmt = ""
173
174todo_include_todos = True
175
176html_use_index = True
177html_domain_indices = True
178
179copyright = f"2021-{now.year}, {author} Built with sphinx {sphinx.__version__} Python {platform.python_version()}"
180
181rst_prolog = """
182.. |thisweek| image:: /images/thisweek_favicon.svg
183"""

gitlab-ci.yaml

 1image: python:3.11.0-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.10.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.5
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)