add multi-version --git-tags

marzer · Jan 28, 2024 · 38bfc71 · 38bfc71
1 parent bc7b86c
commit 38bfc71
Show file tree

Hide file tree

Showing 14 changed files with 436 additions and 154 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -56,6 +56,12 @@ jobs:
                 os:
                     - "ubuntu-22.04"
                     - "ubuntu-20.04"
+                python:
+                    - "3.7"
+                    - "3.8"
+                    - "3.9"
+                    - "3.10"
+                    - "3.11"
 
         runs-on: "${{ matrix.os }}"
 
@@ -67,11 +73,16 @@ jobs:
             - name: Install base dependencies
               run: |
                   sudo apt -y update
-                  sudo apt -y install --no-install-recommends git python3 python3-pip
+                  sudo apt -y install --no-install-recommends git
+
+            - name: Install python
+              uses: actions/setup-python@v5
+              with:
+                  python-version: ${{ matrix.python }}
 
             - name: Install python dependencies
               run: |
-                  sudo python3 -m pip install --upgrade pip build
+                  python -m pip install --upgrade pip build setuptools wheel
 
             - name: Install compiler dependencies
               if: ${{ matrix.doxygen_tag != 'none' }}
@@ -104,7 +115,7 @@ jobs:
             - name: Install poxy
               run: |
                   cd "${{ github.workspace }}/repo"
-                  sudo python3 -m pip install --upgrade .
+                  python -m pip install --upgrade .
 
             - name: Print poxy help and version
               run: |

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,15 +1,35 @@
 {
 	"prettier.useTabs": true,
 	"prettier.tabWidth": 4,
+	"prettier.printWidth": 120,
+	"prettier.singleAttributePerLine": true,
 	"editor.rulers": [120],
 	"editor.formatOnSave": true,
 	"editor.formatOnPaste": false,
 	"editor.formatOnType": false,
-	"files.eol": "\n",
 	"html.format.indentInnerHtml": true,
+	"files.eol": "\n",
 	"files.exclude": {
 		"**/__pycache__": true,
 		"**/build": true,
 		"**/*.egg-info": true
 	},
+	"files.associations": {
+		"type_traits": "cpp",
+		"concepts": "cpp",
+		"cstddef": "cpp",
+		"cstdint": "cpp",
+		"cstdlib": "cpp",
+		"initializer_list": "cpp",
+		"xstddef": "cpp",
+		"xtr1common": "cpp"
+	},
+	"python.formatting.provider": "none",
+	"[python]": {
+		"editor.defaultFormatter": "ms-python.black-formatter"
+	},
+	"css.format.braceStyle": "expand",
+	"[css]": {
+		"editor.formatOnSave": true
+	}
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.16.0 - 2024-01-28
+
+-   added multi-version mode argument `--git-tags`
+-   added colour to output
+
 ## v0.15.0 - 2023-12-08
 
 -   added config option `main_page` (a.k.a. `USE_MDFILE_AS_MAINPAGE`)

diff --git a/README.md b/README.md
@@ -69,15 +69,14 @@ Poxy is a command-line application.
 ```
 usage: poxy [-h] [-v] [--html | --no-html] [--ppinclude <regex>] [--ppexclude <regex>]
             [--theme {light,dark,custom}] [--threads N] [--version] [--xml | --no-xml]
-            [--werror | --no-werror] [--bug-report]
-            [config]
+            [--werror | --no-werror] [--bug-report] [--git-tags] [config]
 
   _ __   _____  ___   _
  | '_ \ / _ \ \/ / | | |
  | |_) | (_) >  <| |_| |
  | .__/ \___/_/\_\\__, |
  | |               __/ |
- |_|              |___/  v0.12.0 - github.com/marzer/poxy
+ |_|              |___/  v0.16.0 - github.com/marzer/poxy
 
 Generate fancy C++ documentation.
 
@@ -87,17 +86,17 @@ positional arguments:
 options:
   -h, --help            show this help message and exit
   -v, --verbose         enable very noisy diagnostic output
-  --html, --no-html     specify whether HTML output is required (default: True)
+  --html, --no-html     specify whether HTML output is required
   --ppinclude <regex>   pattern matching HTML file names to post-process (default: all)
   --ppexclude <regex>   pattern matching HTML file names to exclude from post-processing (default: none)
   --theme {light,dark,custom}
-                        override the default visual theme (default: read from config)
+                        sets the default visual theme (default: read from config)
   --threads N           set the number of threads to use (default: automatic)
   --version             print the version and exit
-  --xml, --no-xml       specify whether XML output is required (default: False)
-  --werror, --no-werror
-                        override the treating of warnings as errors (default: read from config)
+  --xml, --no-xml       specify whether XML output is required
+  --werror, --no-werror treat warnings as errors (default: read from config)
   --bug-report          captures all output in a zip file for easier bug reporting.
+  --git-tags            add git-tag-based semver version switcher to the generated HTML
 ```
 
 The basic three-step to using Poxy is similar to Doxygen:

diff --git a/poxy.code-workspace b/poxy.code-workspace
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,25 +18,26 @@ authors = [{ name = "Mark Gillard", email = "[email protected]" }]
 license = { text = 'MIT' }
 keywords = ['c++', 'doxygen', 'documentation']
 classifiers = [
-	'Development Status :: 4 - Beta',
-	'License :: OSI Approved :: MIT License',
-	'Programming Language :: C++',
-	'Topic :: Documentation',
-	'Topic :: Software Development :: Code Generators',
-	'Topic :: Software Development :: Documentation',
-	'Topic :: Utilities',
+    'Development Status :: 4 - Beta',
+    'License :: OSI Approved :: MIT License',
+    'Programming Language :: C++',
+    'Topic :: Documentation',
+    'Topic :: Software Development :: Code Generators',
+    'Topic :: Software Development :: Documentation',
+    'Topic :: Utilities',
 ]
 dependencies = [
-	'misk >= 0.8.1',
-	'bs4',
-	'jinja2',
-	'pygments',
-	'html5lib',
-	'lxml',
-	'tomli',
-	'schema != 0.7.5',
-	'requests',
-	'trieregex',
+    'misk >= 0.8.1',
+    'bs4',
+    'jinja2',
+    'pygments',
+    'html5lib',
+    'lxml',
+    'tomli',
+    'schema != 0.7.5',
+    'requests',
+    'trieregex',
+    'colorama',
 ]
 dynamic = ['version', 'readme']
 
@@ -55,8 +56,8 @@ zip-safe = true
 [tool.setuptools.dynamic]
 version = { file = 'src/poxy/version.txt' }
 readme = { file = [
-	'README.md',
-	'CHANGELOG.md',
+    'README.md',
+    'CHANGELOG.md',
 ], content-type = 'text/markdown' }
 
 [tool.setuptools.packages.find]
@@ -65,17 +66,17 @@ include = ["poxy*"]
 
 [tool.setuptools.package-data]
 "*" = [
-	'*.css',
-	'*.woff',
-	'*.woff2',
-	'*.json',
-	'*.rst',
-	'*.html',
-	'*.xml',
-	'*.png',
-	'*.js',
-	'*.svg',
-	'*.txt',
+    '*.css',
+    '*.woff',
+    '*.woff2',
+    '*.json',
+    '*.rst',
+    '*.html',
+    '*.xml',
+    '*.png',
+    '*.js',
+    '*.svg',
+    '*.txt',
 ]
 
 [tool.setuptools.exclude-package-data]

diff --git a/src/poxy/css/poxy-overrides.css b/src/poxy/css/poxy-overrides.css
@@ -26,7 +26,7 @@ body > header {
 	top: 0;
 	left: 0;
 	right: 0;
-	z-index: 5;
+	z-index: 6;
 }
 
 body > main {

diff --git a/src/poxy/generated/poxy.css b/src/poxy/generated/poxy.css
@@ -2638,7 +2638,7 @@ color: var(--color);
 html { height: 100%; scroll-padding-top: 4em; }
 body { min-height: 100%; }
 body { display: flex; flex-direction: column; }
-body > header { position: sticky; top: 0; left: 0; right: 0; z-index: 5; }
+body > header { position: sticky; top: 0; left: 0; right: 0; z-index: 6; }
 body > main { flex: 1 0 auto; }
 body > footer { flex-shrink: 0; }
 body > header,