poxy 0.15.0__tar.gz → 0.17.0__tar.gz

{poxy-0.15.0 → poxy-0.17.0}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v0.17.0 - 2024-04-21
+
+-   added arguments `--min-version` and `--squash-patches` for more control over `--git-tags` mode
+
+## 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`)

{poxy-0.15.0/src/poxy.egg-info → poxy-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: poxy
-Version: 0.15.0
+Version: 0.17.0
 Summary: Documentation generator for C++.
 Author-email: Mark Gillard <mark.gillard@outlook.com.au>
 License: MIT
@@ -28,6 +28,7 @@ Requires-Dist: tomli
 Requires-Dist: schema!=0.7.5
 Requires-Dist: requests
 Requires-Dist: trieregex
+Requires-Dist: colorama
 
 # poxy
 
@@ -100,7 +101,8 @@ 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]
+            [--werror | --no-werror] [--bug-report] [--git-tags]
+            [--squash-patches | --no-squash-patches] [--min-version <version>]
             [config]
 
   _ __   _____  ___   _
@@ -108,7 +110,7 @@ usage: poxy [-h] [-v] [--html | --no-html] [--ppinclude <regex>] [--ppexclude <r
  | |_) | (_) >  <| |_| |
  | .__/ \___/_/\_\\__, |
  | |               __/ |
- |_|              |___/  v0.12.0 - github.com/marzer/poxy
+ |_|              |___/  v0.17.0 - github.com/marzer/poxy
 
 Generate fancy C++ documentation.
 
@@ -118,17 +120,24 @@ 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)
+  --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)
+  --xml, --no-xml       specify whether XML output is required
   --werror, --no-werror
-                        override the treating of warnings as errors (default: read from config)
+                        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
+  --squash-patches, --no-squash-patches
+                        when using --git-tags and two version tags differ by a patch number,
+                        generate docs for the highest one only (default: True)
+  --min-version <version>
+                        sets the minimum version number to emit when using --git-tags,
+                        or a negative integer to mean "the last N versions". (default: None)
 ```
 
 The basic three-step to using Poxy is similar to Doxygen:
@@ -212,6 +221,15 @@ Poxy bundles a fork of m.css, used per the [MIT/Expat license](https://github.co
 
 # Changelog
 
+## v0.17.0 - 2024-04-21
+
+-   added arguments `--min-version` and `--squash-patches` for more control over `--git-tags` mode
+
+## 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`)

{poxy-0.15.0 → poxy-0.17.0}/README.md

@@ -69,7 +69,8 @@ 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]
+            [--werror | --no-werror] [--bug-report] [--git-tags]
+            [--squash-patches | --no-squash-patches] [--min-version <version>]
             [config]
 
   _ __   _____  ___   _
@@ -77,7 +78,7 @@ usage: poxy [-h] [-v] [--html | --no-html] [--ppinclude <regex>] [--ppexclude <r
  | |_) | (_) >  <| |_| |
  | .__/ \___/_/\_\\__, |
  | |               __/ |
- |_|              |___/  v0.12.0 - github.com/marzer/poxy
+ |_|              |___/  v0.17.0 - github.com/marzer/poxy
 
 Generate fancy C++ documentation.
 
@@ -87,17 +88,24 @@ 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)
+  --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)
+  --xml, --no-xml       specify whether XML output is required
   --werror, --no-werror
-                        override the treating of warnings as errors (default: read from config)
+                        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
+  --squash-patches, --no-squash-patches
+                        when using --git-tags and two version tags differ by a patch number,
+                        generate docs for the highest one only (default: True)
+  --min-version <version>
+                        sets the minimum version number to emit when using --git-tags,
+                        or a negative integer to mean "the last N versions". (default: None)
 ```
 
 The basic three-step to using Poxy is similar to Doxygen:

{poxy-0.15.0 → poxy-0.17.0}/pyproject.toml

@@ -18,25 +18,26 @@ authors = [{ name = "Mark Gillard", email = "mark.gillard@outlook.com.au" }]
 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]

{poxy-0.15.0 → poxy-0.17.0}/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 {

{poxy-0.15.0 → poxy-0.17.0}/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,