Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2
changeset 45:6ac1ea5d2d4a
Begin documentation: add the Sphinx generated configuration as-is
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sun, 26 Apr 2026 09:41:33 +0200 |
| parents | 742496328de6 |
| children | a0b9fe464eb2 |
| files | .hgignore Makefile docs/Makefile docs/conf.py docs/index.rst docs/make.bat requirements-docs.txt |
| diffstat | 7 files changed, 120 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/.hgignore Sun Apr 26 09:40:32 2026 +0200 +++ b/.hgignore Sun Apr 26 09:41:33 2026 +0200 @@ -6,3 +6,4 @@ (^|/)_tmp/ ^dist/ ^[^/.]+\.egg-info/ +^docs/_build/
--- a/Makefile Sun Apr 26 09:40:32 2026 +0200 +++ b/Makefile Sun Apr 26 09:41:33 2026 +0200 @@ -4,7 +4,7 @@ # SPDX-License-Identifier: MIT # :- -.PHONY: help all clean distclean dist build tests flake8 install-dev +.PHONY: help all clean distclean dist build tests flake8 docs clean-docs clean-docs-html install-dev install-docs help: @echo Targets: help, clean, distclean, dist, build @@ -30,5 +30,18 @@ -flake8 pygments_lexer_pseudocode2 -flake8 tests +docs: + (cd docs && make html) + +clean-docs: + (cd docs && make clean) + +clean-docs-html: + rm -rf docs/_build/html + install-dev: python -m pip install -r requirements-dev.txt + +install-docs: + python -m pip install -r requirements-docs.txt + python -m pip install --editable .
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/Makefile Sun Apr 26 09:41:33 2026 +0200 @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/conf.py Sun Apr 26 09:41:33 2026 +0200 @@ -0,0 +1,28 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Pygments Pseudocode Lexer' +copyright = '2026, Franz Glasner' +author = 'Franz Glasner' +release = '2.0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static']
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/index.rst Sun Apr 26 09:41:33 2026 +0200 @@ -0,0 +1,20 @@ +.. Pygments Pseudocode Lexer documentation master file, created by + sphinx-quickstart on Sun Apr 26 09:33:13 2026. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Pygments Pseudocode Lexer's documentation! +===================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/make.bat Sun Apr 26 09:41:33 2026 +0200 @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd