From 87502947781a764e1f6c8dd2eb1fcc2845a53760 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 11:48:10 +0200 Subject: [PATCH 01/38] Update docs build --- .github/workflows/docs.yml | 27 ++++++++++----------------- docs/Makefile | 2 +- docs/conf.py | 4 ++-- docs/make.bat | 2 +- 4 files changed, 14 insertions(+), 21 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index fa66a8f..77ab6a9 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,9 +1,7 @@ name: Docs on: - #push: - # branches-ignore: - # - '**' + workflow_dispatch: push: branches: [ master ] pull_request: @@ -12,25 +10,20 @@ on: jobs: build: - runs-on: macos-latest + runs-on: ubuntu-latest steps: - - name: Install Requirements - run: brew install doxygen - && brew install sphinx-doc - && pip3 install sphinx-rtd-theme - && pip3 install breathe - && pip3 install sphinx-sitemap - name: Checkout Repo - uses: actions/checkout@1.0.0 - - name: Build Docs - run: cd docs - && make html - && cd temp_build/html - && touch .nojekyll + uses: actions/checkout@v4 + - uses: actions/setup-python@v3 + - name: Build the Docs + uses: ammaraskar/sphinx-action@master + with: + pre-build-command: "apt-get update -y && apt-get install -y doxygen && pip install sphinx_rtd_theme breathe sphinx-sitemap" + docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} BRANCH: gh-pages # The branch the action should deploy to. - FOLDER: docs/temp_build/html # The folder the action should deploy. \ No newline at end of file + FOLDER: docs/_build/html # The folder the action should deploy. \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile index d97a551..298ea9e 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build SOURCEDIR = . -BUILDDIR = temp_build +BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/conf.py b/docs/conf.py index 3724ae8..868445a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,7 +78,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [u'temp_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None @@ -128,7 +128,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['temp_static'] +html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. diff --git a/docs/make.bat b/docs/make.bat index 93fa0f6..7893348 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -8,7 +8,7 @@ if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set SOURCEDIR=. -set BUILDDIR=temp_build +set BUILDDIR=_build if "%1" == "" goto help From 1a72165da262992bdb05c4c1f5fb086194ac8046 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 11:52:55 +0200 Subject: [PATCH 02/38] Use install doxygen action --- .github/workflows/docs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 77ab6a9..5682e93 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -16,10 +16,11 @@ jobs: - name: Checkout Repo uses: actions/checkout@v4 - uses: actions/setup-python@v3 + - uses: ssciwr/doxygen-install@v1 - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - pre-build-command: "apt-get update -y && apt-get install -y doxygen && pip install sphinx_rtd_theme breathe sphinx-sitemap" + pre-build-command: "pip install sphinx_rtd_theme breathe sphinx-sitemap" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From 8a29f9fca6e769d7b22d80db2bd30d65f56a8ed8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 11:55:25 +0200 Subject: [PATCH 03/38] Update Makefile --- docs/Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 298ea9e..8762bd5 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,8 +2,8 @@ # # You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = _build From b4cc8484840979806ba8b853650798a031cb6305 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:00:49 +0200 Subject: [PATCH 04/38] Update Makefile --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index 8762bd5..0e1043a 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS ?= +SPHINXOPTS += SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = _build From df8a487b95be620f301a7f6469aff4705e91034f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:06:01 +0200 Subject: [PATCH 05/38] Add requirements.txt --- .github/workflows/docs.yml | 1 - docs/Makefile | 2 +- docs/conf.py | 2 +- docs/make.bat | 2 +- docs/requirements.txt | 5 +++++ 5 files changed, 8 insertions(+), 4 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5682e93..ee64ae0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,7 +20,6 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - pre-build-command: "pip install sphinx_rtd_theme breathe sphinx-sitemap" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 diff --git a/docs/Makefile b/docs/Makefile index 0e1043a..64b3357 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,7 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS += SPHINXBUILD ?= sphinx-build -SOURCEDIR = . +SOURCEDIR = source BUILDDIR = _build # Put it first so that "make" without argument is like "make help". diff --git a/docs/conf.py b/docs/conf.py index 868445a..730f565 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ author = u'Tomasz Gałaj' # The short X.Y version -version = u'' +version = u'2.0' # The full version, including alpha/beta/rc tags release = u'' diff --git a/docs/make.bat b/docs/make.bat index 7893348..7843185 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,7 +7,7 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=. +set SOURCEDIR=source set BUILDDIR=_build if "%1" == "" goto help diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..c6a0cf6 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +sphinx>=6.1.3 +docutils>=0.19 +sphinx_rtd_theme +breathe +sphinx-sitemap \ No newline at end of file From a909783b7ddabfcbd3d44cd4f46885509de75d20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:08:23 +0200 Subject: [PATCH 06/38] Forgot to move the files --- docs/{ => source}/Doxyfile.in | 0 docs/{ => source}/conf.py | 0 docs/{ => source}/index.rst | 0 docs/{ => source}/strutil.rst | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename docs/{ => source}/Doxyfile.in (100%) rename docs/{ => source}/conf.py (100%) rename docs/{ => source}/index.rst (100%) rename docs/{ => source}/strutil.rst (100%) diff --git a/docs/Doxyfile.in b/docs/source/Doxyfile.in similarity index 100% rename from docs/Doxyfile.in rename to docs/source/Doxyfile.in diff --git a/docs/conf.py b/docs/source/conf.py similarity index 100% rename from docs/conf.py rename to docs/source/conf.py diff --git a/docs/index.rst b/docs/source/index.rst similarity index 100% rename from docs/index.rst rename to docs/source/index.rst diff --git a/docs/strutil.rst b/docs/source/strutil.rst similarity index 100% rename from docs/strutil.rst rename to docs/source/strutil.rst From 17d7b0f23a3a784b7ef915a473afdf46909b7985 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:14:30 +0200 Subject: [PATCH 07/38] update --- .github/workflows/docs.yml | 4 ++-- docs/Makefile | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ee64ae0..1441260 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,8 +15,8 @@ jobs: steps: - name: Checkout Repo uses: actions/checkout@v4 - - uses: actions/setup-python@v3 - - uses: ssciwr/doxygen-install@v1 + - name: Install Doxygen + uses: ssciwr/doxygen-install@v1 - name: Build the Docs uses: ammaraskar/sphinx-action@master with: diff --git a/docs/Makefile b/docs/Makefile index 64b3357..cc17ecd 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS += +SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source BUILDDIR = _build From a4dc654117acf7435f6df0d6cfa784411ef36b26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:21:19 +0200 Subject: [PATCH 08/38] test --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1441260..d32818f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,6 +20,7 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: + build-command: "sphinx-build source _build -b html -w /tmp/sphinx.log -E" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From e2d212d4826cb0ed7dda650fc607fa09b2e41e29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:23:41 +0200 Subject: [PATCH 09/38] update --- docs/conf.py | 236 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 236 insertions(+) create mode 100644 docs/conf.py diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..455b765 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,236 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +from sphinx.builders.html import StandaloneHTMLBuilder +import subprocess, os + +# Doxygen +subprocess.call('doxygen Doxyfile.in', shell=True) + +# -- Project information ----------------------------------------------------- + +project = u'strutil' +copyright = u'2022, Tomasz Gałaj' +author = u'Tomasz Gałaj' + +# The short X.Y version +version = u'2.0' +# The full version, including alpha/beta/rc tags +release = u'' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.autosectionlabel', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx_sitemap', + 'sphinx.ext.inheritance_diagram', + 'breathe' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['temp_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + +highlight_language = 'c++' + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +html_theme_options = { + 'canonical_url': '', + 'analytics_id': '', + 'display_version': True, + 'prev_next_buttons_location': 'bottom', + 'style_external_links': False, + + 'logo_only': False, + + # Toc options + 'collapse_navigation': True, + 'sticky_navigation': True, + 'navigation_depth': 4, + 'includehidden': True, + 'titles_only': False +} + +html_context = { + 'display_github': True, + 'github_user': 'tgalaj', + 'github_repo': 'strutil', + 'github_version': 'master/docs/', +} +# html_logo = '' +# github_url = '' +# html_baseurl = '' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'strutildoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'strutil.tex', u'strutil Documentation', + u'Tomasz Gałaj', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'strutil', u'strutil Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'strutil', u'strutil Documentation', + author, 'strutil', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- +# -- Breathe configuration --------------------------------------------------- + +breathe_projects = { + "strutil": "_build/xml/" +} +breathe_default_project = "strutil" +breathe_default_members = ('members', 'undoc-members') + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True From 3f23b42157697d6bb5ea379a71919c2a16e9c494 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:26:20 +0200 Subject: [PATCH 10/38] update --- .github/workflows/docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d32818f..1441260 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,7 +20,6 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - build-command: "sphinx-build source _build -b html -w /tmp/sphinx.log -E" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From 2025767f0bcd15a368ceb2da4699a53a9ce95781 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:29:35 +0200 Subject: [PATCH 11/38] update --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 455b765..9b37970 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -220,7 +220,7 @@ # -- Breathe configuration --------------------------------------------------- breathe_projects = { - "strutil": "_build/xml/" + "strutil": "_build/source/xml/" } breathe_default_project = "strutil" breathe_default_members = ('members', 'undoc-members') From 3ae89b79c474b49ea17fb90a8a9074656512042f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:33:37 +0200 Subject: [PATCH 12/38] update --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1441260..d32818f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,6 +20,7 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: + build-command: "sphinx-build source _build -b html -w /tmp/sphinx.log -E" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From 89ee62edcd91dd3d024ec1a656b6fb64b8162fb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:41:28 +0200 Subject: [PATCH 13/38] update --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d32818f..4e6124a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,7 +20,7 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - build-command: "sphinx-build source _build -b html -w /tmp/sphinx.log -E" + build-command: make html -E docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From c054fdb914c52cca8894cda468ce00630c936b70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:48:12 +0200 Subject: [PATCH 14/38] update --- .github/workflows/docs.yml | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4e6124a..716fae0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -9,9 +9,9 @@ on: jobs: build: - runs-on: ubuntu-latest - + permissions: + contents: write steps: - name: Checkout Repo uses: actions/checkout@v4 @@ -20,11 +20,9 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - build-command: make html -E + pre-build-command: make clean docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - BRANCH: gh-pages # The branch the action should deploy to. - FOLDER: docs/_build/html # The folder the action should deploy. \ No newline at end of file + folder: docs/_build/html # The folder the action should deploy. \ No newline at end of file From 38a69616baf23455935e7e4212464ebd203cee09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:51:59 +0200 Subject: [PATCH 15/38] update --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 716fae0..f2dcebe 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,6 +17,7 @@ jobs: uses: actions/checkout@v4 - name: Install Doxygen uses: ssciwr/doxygen-install@v1 + - run: pip cache purge - name: Build the Docs uses: ammaraskar/sphinx-action@master with: From e71c904d0be2b52e6a810574dff6f4547e206934 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:53:44 +0200 Subject: [PATCH 16/38] update --- .github/workflows/docs.yml | 1 - docs/conf.py | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f2dcebe..716fae0 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,7 +17,6 @@ jobs: uses: actions/checkout@v4 - name: Install Doxygen uses: ssciwr/doxygen-install@v1 - - run: pip cache purge - name: Build the Docs uses: ammaraskar/sphinx-action@master with: diff --git a/docs/conf.py b/docs/conf.py index 9b37970..7ecd76c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -220,7 +220,7 @@ # -- Breathe configuration --------------------------------------------------- breathe_projects = { - "strutil": "_build/source/xml/" + "strutil": "source/_build/xml/" } breathe_default_project = "strutil" breathe_default_members = ('members', 'undoc-members') From b7cfdd0b5f30048f38a8aba4da0181b83be80be2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:55:42 +0200 Subject: [PATCH 17/38] update --- .github/workflows/docs.yml | 2 +- docs/Makefile | 2 +- docs/conf.py | 4 ++-- docs/make.bat | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 716fae0..1bf8552 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,4 +25,4 @@ jobs: - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 with: - folder: docs/_build/html # The folder the action should deploy. \ No newline at end of file + folder: docs/temp_build/html # The folder the action should deploy. \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile index cc17ecd..0052901 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source -BUILDDIR = _build +BUILDDIR = temp_build # Put it first so that "make" without argument is like "make help". help: diff --git a/docs/conf.py b/docs/conf.py index 7ecd76c..5297409 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,7 +78,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [u'temp_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None @@ -220,7 +220,7 @@ # -- Breathe configuration --------------------------------------------------- breathe_projects = { - "strutil": "source/_build/xml/" + "strutil": "source/temp_build/xml/" } breathe_default_project = "strutil" breathe_default_members = ('members', 'undoc-members') diff --git a/docs/make.bat b/docs/make.bat index 7843185..5a3d74f 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -8,7 +8,7 @@ if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set SOURCEDIR=source -set BUILDDIR=_build +set BUILDDIR=temp_build if "%1" == "" goto help From f6ad846668d92e479bba41f328839501116bf0d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 12:58:22 +0200 Subject: [PATCH 18/38] update --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index c6a0cf6..138c63d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ sphinx>=6.1.3 docutils>=0.19 sphinx_rtd_theme -breathe +breathe>=4.35.0 sphinx-sitemap \ No newline at end of file From e13ac1cf92291342b7dc1913b9f9f5575cfb3a1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:06:16 +0200 Subject: [PATCH 19/38] update --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 138c63d..6d1e5c5 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,5 @@ sphinx>=6.1.3 +sphinx-doc docutils>=0.19 sphinx_rtd_theme breathe>=4.35.0 From 61f287fd30c583124fb60f9aefe7b7161101c475 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:07:23 +0200 Subject: [PATCH 20/38] update --- .github/workflows/docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1bf8552..5e673da 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,7 +20,6 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - pre-build-command: make clean docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From c1ba2de16d1233e109b902f85a4e6f04360578ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:09:37 +0200 Subject: [PATCH 21/38] update --- docs/requirements.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 6d1e5c5..138c63d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,4 @@ sphinx>=6.1.3 -sphinx-doc docutils>=0.19 sphinx_rtd_theme breathe>=4.35.0 From 064f34dc4dd4546acc99ea880e8c5bf8a4e9845a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:13:30 +0200 Subject: [PATCH 22/38] update --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 5297409..1951611 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -220,7 +220,7 @@ # -- Breathe configuration --------------------------------------------------- breathe_projects = { - "strutil": "source/temp_build/xml/" + "strutil": "temp_build/xml/" } breathe_default_project = "strutil" breathe_default_members = ('members', 'undoc-members') From cc72752cefbd86028fcbecf0731c588b533061a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:15:57 +0200 Subject: [PATCH 23/38] update --- docs/{source => }/Doxyfile.in | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{source => }/Doxyfile.in (100%) diff --git a/docs/source/Doxyfile.in b/docs/Doxyfile.in similarity index 100% rename from docs/source/Doxyfile.in rename to docs/Doxyfile.in From 7a6f5d2f7199744514649f4054d2a16208768758 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:22:03 +0200 Subject: [PATCH 24/38] update --- .github/workflows/docs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5e673da..f207987 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,8 +15,6 @@ jobs: steps: - name: Checkout Repo uses: actions/checkout@v4 - - name: Install Doxygen - uses: ssciwr/doxygen-install@v1 - name: Build the Docs uses: ammaraskar/sphinx-action@master with: From c78a2881dae0c66a40c0cd7cd58cfd506fb0b94b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:25:05 +0200 Subject: [PATCH 25/38] update --- .github/workflows/docs.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f207987..1c0267d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,6 +15,23 @@ jobs: steps: - name: Checkout Repo uses: actions/checkout@v4 + - name: install dependencies + run: | + pip install -r requirements/development.txt + sudo apt-get -y update + sudo apt-get -y install graphviz libclang1-11 libclang-cpp11 + + - name: install doxygen from SF binary archives + env: + DOXYGEN_VERSION: 1.9.4 + run: | + mkdir doxygen-bin-arc && cd doxygen-bin-arc + curl -L https://sourceforge.net/projects/doxygen/files/rel-$DOXYGEN_VERSION/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz > doxygen.tar.gz + gunzip doxygen.tar.gz + tar xf doxygen.tar + cd doxygen-$DOXYGEN_VERSION + sudo make install + - name: Build the Docs uses: ammaraskar/sphinx-action@master with: From 6ed8381636467a64f1308b84e22cba906c094a9c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:26:03 +0200 Subject: [PATCH 26/38] update --- .github/workflows/docs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1c0267d..1f06bcc 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,7 +17,6 @@ jobs: uses: actions/checkout@v4 - name: install dependencies run: | - pip install -r requirements/development.txt sudo apt-get -y update sudo apt-get -y install graphviz libclang1-11 libclang-cpp11 From 7a25cda99caa0e5c8b978a3da23621bdc86260da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:30:13 +0200 Subject: [PATCH 27/38] update --- .github/workflows/docs.yml | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1f06bcc..2c445e1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,25 +15,10 @@ jobs: steps: - name: Checkout Repo uses: actions/checkout@v4 - - name: install dependencies - run: | - sudo apt-get -y update - sudo apt-get -y install graphviz libclang1-11 libclang-cpp11 - - - name: install doxygen from SF binary archives - env: - DOXYGEN_VERSION: 1.9.4 - run: | - mkdir doxygen-bin-arc && cd doxygen-bin-arc - curl -L https://sourceforge.net/projects/doxygen/files/rel-$DOXYGEN_VERSION/doxygen-$DOXYGEN_VERSION.linux.bin.tar.gz > doxygen.tar.gz - gunzip doxygen.tar.gz - tar xf doxygen.tar - cd doxygen-$DOXYGEN_VERSION - sudo make install - - name: Build the Docs uses: ammaraskar/sphinx-action@master with: + pre-build-command: "sudo apt-get update -y && sudo apt-get install -y doxygen" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From b16453f43dbbce24ac19f8e29223f0e304a556be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:32:11 +0200 Subject: [PATCH 28/38] update --- .github/workflows/docs.yml | 2 +- docs/requirements.txt | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2c445e1..234e867 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,7 +18,7 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - pre-build-command: "sudo apt-get update -y && sudo apt-get install -y doxygen" + pre-build-command: "sudo apt-get update -y && sudo apt-get install -y doxygen && pip install breathe" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 diff --git a/docs/requirements.txt b/docs/requirements.txt index 138c63d..97db896 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,4 @@ sphinx>=6.1.3 docutils>=0.19 sphinx_rtd_theme -breathe>=4.35.0 sphinx-sitemap \ No newline at end of file From 31a0fe2bb6906881ef03635183cb0be88a715b51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:39:06 +0200 Subject: [PATCH 29/38] update --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 234e867..a8fc051 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,7 +18,7 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - pre-build-command: "sudo apt-get update -y && sudo apt-get install -y doxygen && pip install breathe" + pre-build-command: "apt-get update -y && apt-get install -y doxygen && pip install breathe" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 From 8e8411ecbffd52023f6007eaa58182c13bb3a591 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:40:29 +0200 Subject: [PATCH 30/38] update --- .github/workflows/docs.yml | 2 +- docs/requirements.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a8fc051..fe12329 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,7 +18,7 @@ jobs: - name: Build the Docs uses: ammaraskar/sphinx-action@master with: - pre-build-command: "apt-get update -y && apt-get install -y doxygen && pip install breathe" + pre-build-command: "apt-get update -y && apt-get install -y doxygen" docs-folder: "docs/" - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 diff --git a/docs/requirements.txt b/docs/requirements.txt index 97db896..ea1a1d6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,4 @@ +breathe>=4.29.0 sphinx>=6.1.3 docutils>=0.19 sphinx_rtd_theme From 7a68c93a1fd61937cac536a3a3e4fb9d7073be53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:48:48 +0200 Subject: [PATCH 31/38] update --- .github/workflows/docs.yml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index fe12329..29d2a4d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,11 +15,14 @@ jobs: steps: - name: Checkout Repo uses: actions/checkout@v4 - - name: Build the Docs - uses: ammaraskar/sphinx-action@master - with: - pre-build-command: "apt-get update -y && apt-get install -y doxygen" - docs-folder: "docs/" + - name: Install Python + uses: actions/setup-python@v3 + - name: Install dependencies + run: | + pip install sphinx sphinx_rtd_theme sphinx-sitemap breathe docutils + - name: Sphinx Build + run: | + sphinx-build docs temp_build - name: Deploy uses: JamesIves/github-pages-deploy-action@releases/v3 with: From a5f58dc6eb439510bdc8cfdbd200744fdfbc1bb5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:50:25 +0200 Subject: [PATCH 32/38] update --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 29d2a4d..80bc863 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -19,6 +19,7 @@ jobs: uses: actions/setup-python@v3 - name: Install dependencies run: | + apt-get update -y && apt-get install doxygen graphviz -y pip install sphinx sphinx_rtd_theme sphinx-sitemap breathe docutils - name: Sphinx Build run: | From 102d4c065d10bd73f9229aa13a1f6b62b591d535 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 13:52:30 +0200 Subject: [PATCH 33/38] update --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 80bc863..8f9047f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,9 +17,9 @@ jobs: uses: actions/checkout@v4 - name: Install Python uses: actions/setup-python@v3 + - uses: ssciwr/doxygen-install@v1 - name: Install dependencies run: | - apt-get update -y && apt-get install doxygen graphviz -y pip install sphinx sphinx_rtd_theme sphinx-sitemap breathe docutils - name: Sphinx Build run: | From 2280c30f0402aac5c1165650b76f471c3e91e060 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 14:07:22 +0200 Subject: [PATCH 34/38] update --- docs/Makefile | 2 +- docs/conf.py | 2 +- docs/{source => }/index.rst | 0 docs/make.bat | 2 +- docs/source/conf.py | 236 ---------------------------------- docs/{source => }/strutil.rst | 0 6 files changed, 3 insertions(+), 239 deletions(-) rename docs/{source => }/index.rst (100%) delete mode 100644 docs/source/conf.py rename docs/{source => }/strutil.rst (100%) diff --git a/docs/Makefile b/docs/Makefile index 0052901..8e89358 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,7 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = source +SOURCEDIR = . BUILDDIR = temp_build # Put it first so that "make" without argument is like "make help". diff --git a/docs/conf.py b/docs/conf.py index 1951611..730f565 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,7 +78,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [u'temp_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/make.bat b/docs/make.bat index 5a3d74f..93fa0f6 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,7 +7,7 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=source +set SOURCEDIR=. set BUILDDIR=temp_build if "%1" == "" goto help diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index 730f565..0000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,236 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Configuration file for the Sphinx documentation builder. -# -# This file does only contain a selection of the most common options. For a -# full list see the documentation: -# http://www.sphinx-doc.org/en/master/config - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) -from sphinx.builders.html import StandaloneHTMLBuilder -import subprocess, os - -# Doxygen -subprocess.call('doxygen Doxyfile.in', shell=True) - -# -- Project information ----------------------------------------------------- - -project = u'strutil' -copyright = u'2022, Tomasz Gałaj' -author = u'Tomasz Gałaj' - -# The short X.Y version -version = u'2.0' -# The full version, including alpha/beta/rc tags -release = u'' - - -# -- General configuration --------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.autosectionlabel', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', - 'sphinx.ext.mathjax', - 'sphinx.ext.ifconfig', - 'sphinx.ext.viewcode', - 'sphinx_sitemap', - 'sphinx.ext.inheritance_diagram', - 'breathe' -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['temp_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = None - -highlight_language = 'c++' - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -html_theme_options = { - 'canonical_url': '', - 'analytics_id': '', - 'display_version': True, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': False, - - 'logo_only': False, - - # Toc options - 'collapse_navigation': True, - 'sticky_navigation': True, - 'navigation_depth': 4, - 'includehidden': True, - 'titles_only': False -} - -html_context = { - 'display_github': True, - 'github_user': 'tgalaj', - 'github_repo': 'strutil', - 'github_version': 'master/docs/', -} -# html_logo = '' -# github_url = '' -# html_baseurl = '' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'strutildoc' - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'strutil.tex', u'strutil Documentation', - u'Tomasz Gałaj', 'manual'), -] - - -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'strutil', u'strutil Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'strutil', u'strutil Documentation', - author, 'strutil', 'One line description of project.', - 'Miscellaneous'), -] - - -# -- Options for Epub output ------------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -# -# epub_identifier = '' - -# A unique identification for the text. -# -# epub_uid = '' - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - - -# -- Extension configuration ------------------------------------------------- -# -- Breathe configuration --------------------------------------------------- - -breathe_projects = { - "strutil": "temp_build/xml/" -} -breathe_default_project = "strutil" -breathe_default_members = ('members', 'undoc-members') - -# -- Options for intersphinx extension --------------------------------------- - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - -# -- Options for todo extension ---------------------------------------------- - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True diff --git a/docs/source/strutil.rst b/docs/strutil.rst similarity index 100% rename from docs/source/strutil.rst rename to docs/strutil.rst From 81d35484ae0c98dcec211e2e6f91d582892d7fa7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 14:09:19 +0200 Subject: [PATCH 35/38] update --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8f9047f..e349a9b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -25,6 +25,6 @@ jobs: run: | sphinx-build docs temp_build - name: Deploy - uses: JamesIves/github-pages-deploy-action@releases/v3 + uses: JamesIves/github-pages-deploy-action@v4 with: folder: docs/temp_build/html # The folder the action should deploy. \ No newline at end of file From ea615b79fad44cf27e1d9ead0884f707aa962227 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 14:13:55 +0200 Subject: [PATCH 36/38] update --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 730f565..b2032d1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -78,7 +78,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [u'temp_build', 'Thumbs.db', '.DS_Store'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = None @@ -128,7 +128,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['temp_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. From 81b3d94635ccb3b9d0682c613ed146c043600a20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 14:20:53 +0200 Subject: [PATCH 37/38] update --- .github/workflows/docs.yml | 6 +++++- docs/Doxyfile.in | 2 +- docs/conf.py | 2 +- docs/index.rst | 2 +- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e349a9b..4a4510e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -23,7 +23,11 @@ jobs: pip install sphinx sphinx_rtd_theme sphinx-sitemap breathe docutils - name: Sphinx Build run: | - sphinx-build docs temp_build + cd docs + make html + cd temp_build/html + touch .nojekyll + #sphinx-build docs temp_build - name: Deploy uses: JamesIves/github-pages-deploy-action@v4 with: diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 1727dc3..1638db5 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -38,7 +38,7 @@ PROJECT_NAME = strutil # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.0.2 +PROJECT_NUMBER = 2.0.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/docs/conf.py b/docs/conf.py index b2032d1..24cb6e0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -228,7 +228,7 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} # -- Options for todo extension ---------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 98f74f2..0e22c1c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,7 +6,7 @@ strutil ======= -Easy to use, header only C++ 17 std::string utility library. +Easy to use, header only C++ 20 std::string utility library. Any constructive comments and improvements to this little library are more than welcome. From be7798c8e9678f84531fa69ab19b7ae798be24f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tomasz=20Ga=C5=82aj?= Date: Fri, 17 May 2024 14:22:59 +0200 Subject: [PATCH 38/38] update --- .github/workflows/docs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 4a4510e..d2f9690 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,8 +17,9 @@ jobs: uses: actions/checkout@v4 - name: Install Python uses: actions/setup-python@v3 - - uses: ssciwr/doxygen-install@v1 - - name: Install dependencies + - name: Install Doxygen + uses: ssciwr/doxygen-install@v1 + - name: Install Dependencies run: | pip install sphinx sphinx_rtd_theme sphinx-sitemap breathe docutils - name: Sphinx Build @@ -27,8 +28,7 @@ jobs: make html cd temp_build/html touch .nojekyll - #sphinx-build docs temp_build - name: Deploy uses: JamesIves/github-pages-deploy-action@v4 with: - folder: docs/temp_build/html # The folder the action should deploy. \ No newline at end of file + folder: docs/temp_build/html # The folder the action should deploy \ No newline at end of file