mkdoxybook2 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. mkdoxybook2-0.1.0/LICENSE +21 -0
  2. mkdoxybook2-0.1.0/PKG-INFO +87 -0
  3. mkdoxybook2-0.1.0/README.md +62 -0
  4. mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/PKG-INFO +87 -0
  5. mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/SOURCES.txt +9 -0
  6. mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/dependency_links.txt +1 -0
  7. mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/entry_points.txt +2 -0
  8. mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/requires.txt +1 -0
  9. mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/top_level.txt +1 -0
  10. mkdoxybook2-0.1.0/pyproject.toml +40 -0
  11. mkdoxybook2-0.1.0/setup.cfg +4 -0
mkdoxybook2-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 She Shaoke
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
mkdoxybook2-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,87 @@
1
+ Metadata-Version: 2.4
2
+ Name: mkdoxybook2
3
+ Version: 0.1.0
4
+ Summary: A Doxybook2 Helper Plugin for MkDocs documentations
5
+ Author-email: ACoderOrHacker <ACoderOrHacker@zohomail.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/ACoderOrHacker/mkdoxybook2
8
+ Project-URL: Bug Tracker, https://github.com/ACoderOrHacker/mkdoxybook2/issues
9
+ Keywords: mkdocs,doxygen,doxybook2,documentation
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Framework :: MkDocs
20
+ Requires-Python: >=3.8
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Requires-Dist: mkdocs>=1.5.0
24
+ Dynamic: license-file
25
+
26
+ # Introduction
27
+
28
+ `mkdocs-doxybook2` is a MkDocs Plugin for doxygen output.
29
+ It uses `doxybook2` to convert Doxygen XML to Markdown files.
30
+
31
+ # Requirements
32
+
33
+ Before using it, [Doxygen](https://doxygen.nl) and `Doxybook2` are required. You should install them first.
34
+
35
+ > [!NOTE]
36
+ > The main repository of [Doxybook2](https://github.com/matusnovak/doxybook2) has been archived.
37
+ > For newer features, you can install [GeniusVentures/doxybook2](https://github.com/GeniusVentures/doxybook2).
38
+
39
+ # Usage
40
+
41
+ Add the plugin to your `mkdocs.yml` configuration:
42
+
43
+ ```yaml
44
+ plugins:
45
+ - mkdoxybook2
46
+ ```
47
+
48
+ ## Options
49
+
50
+ You can configure the plugin by adding options to the `mkdocs.yml` configuration:
51
+
52
+ ```yaml
53
+ plugins:
54
+ - mkdoxybook2:
55
+ doxygen-path: # Optional, default to `doxygen`
56
+ doxybook2-path: # Optional, default to `doxybook2`
57
+ output-dir: # Optional, default to `mkdoxygen_output`
58
+ projects: # Define projects to generate documentation for, see details below
59
+ doxy-cfg: # Optional, global Doxygen configuration
60
+ doxybook2-cfg: # Optional, global Doxybook2 configuration
61
+ ```
62
+
63
+ | Option | Description |
64
+ | -------------- | --------------------------------------------------------------------------- |
65
+ | doxygen-path | The path of Doxygen. Default to `doxygen`. |
66
+ | doxybook2-path | The path of Doxybook2. Default to `doxybook2`. |
67
+ | output-dir | The internal documentation output directory. Default to `mkdoxygen_output`. |
68
+ | projects | Define projects to generate documentation for |
69
+ | doxy-cfg | Optional, global Doxygen configuration. |
70
+ | doxybook2-cfg | Optional, global Doxybook2 configuration. |
71
+
72
+ ### Option `projects`
73
+
74
+ Add multiple projects to generate documentation for.
75
+ You can add projects with the following structure:
76
+
77
+ ```yaml
78
+ projects:
79
+ <name>:
80
+ src-dirs: # Source directories to scan for documentation
81
+ full-doc: True # Optional, generate full documentation
82
+ output-dir: # Optional, output directory
83
+ doxy-cfg: # Optional, Doxygen configuration
84
+ doxybook2-cfg: # Optional, Doxybook2 configuration
85
+ ```
86
+
87
+ `doxy-cfg` and `doxybook2-cfg` are optional, and will be merged with the global configuration. They have higher priority than global.
mkdoxybook2-0.1.0/README.md ADDED
@@ -0,0 +1,62 @@
1
+ # Introduction
2
+
3
+ `mkdocs-doxybook2` is a MkDocs Plugin for doxygen output.
4
+ It uses `doxybook2` to convert Doxygen XML to Markdown files.
5
+
6
+ # Requirements
7
+
8
+ Before using it, [Doxygen](https://doxygen.nl) and `Doxybook2` are required. You should install them first.
9
+
10
+ > [!NOTE]
11
+ > The main repository of [Doxybook2](https://github.com/matusnovak/doxybook2) has been archived.
12
+ > For newer features, you can install [GeniusVentures/doxybook2](https://github.com/GeniusVentures/doxybook2).
13
+
14
+ # Usage
15
+
16
+ Add the plugin to your `mkdocs.yml` configuration:
17
+
18
+ ```yaml
19
+ plugins:
20
+ - mkdoxybook2
21
+ ```
22
+
23
+ ## Options
24
+
25
+ You can configure the plugin by adding options to the `mkdocs.yml` configuration:
26
+
27
+ ```yaml
28
+ plugins:
29
+ - mkdoxybook2:
30
+ doxygen-path: # Optional, default to `doxygen`
31
+ doxybook2-path: # Optional, default to `doxybook2`
32
+ output-dir: # Optional, default to `mkdoxygen_output`
33
+ projects: # Define projects to generate documentation for, see details below
34
+ doxy-cfg: # Optional, global Doxygen configuration
35
+ doxybook2-cfg: # Optional, global Doxybook2 configuration
36
+ ```
37
+
38
+ | Option | Description |
39
+ | -------------- | --------------------------------------------------------------------------- |
40
+ | doxygen-path | The path of Doxygen. Default to `doxygen`. |
41
+ | doxybook2-path | The path of Doxybook2. Default to `doxybook2`. |
42
+ | output-dir | The internal documentation output directory. Default to `mkdoxygen_output`. |
43
+ | projects | Define projects to generate documentation for |
44
+ | doxy-cfg | Optional, global Doxygen configuration. |
45
+ | doxybook2-cfg | Optional, global Doxybook2 configuration. |
46
+
47
+ ### Option `projects`
48
+
49
+ Add multiple projects to generate documentation for.
50
+ You can add projects with the following structure:
51
+
52
+ ```yaml
53
+ projects:
54
+ <name>:
55
+ src-dirs: # Source directories to scan for documentation
56
+ full-doc: True # Optional, generate full documentation
57
+ output-dir: # Optional, output directory
58
+ doxy-cfg: # Optional, Doxygen configuration
59
+ doxybook2-cfg: # Optional, Doxybook2 configuration
60
+ ```
61
+
62
+ `doxy-cfg` and `doxybook2-cfg` are optional, and will be merged with the global configuration. They have higher priority than global.
mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/PKG-INFO ADDED
@@ -0,0 +1,87 @@
1
+ Metadata-Version: 2.4
2
+ Name: mkdoxybook2
3
+ Version: 0.1.0
4
+ Summary: A Doxybook2 Helper Plugin for MkDocs documentations
5
+ Author-email: ACoderOrHacker <ACoderOrHacker@zohomail.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/ACoderOrHacker/mkdoxybook2
8
+ Project-URL: Bug Tracker, https://github.com/ACoderOrHacker/mkdoxybook2/issues
9
+ Keywords: mkdocs,doxygen,doxybook2,documentation
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Framework :: MkDocs
20
+ Requires-Python: >=3.8
21
+ Description-Content-Type: text/markdown
22
+ License-File: LICENSE
23
+ Requires-Dist: mkdocs>=1.5.0
24
+ Dynamic: license-file
25
+
26
+ # Introduction
27
+
28
+ `mkdocs-doxybook2` is a MkDocs Plugin for doxygen output.
29
+ It uses `doxybook2` to convert Doxygen XML to Markdown files.
30
+
31
+ # Requirements
32
+
33
+ Before using it, [Doxygen](https://doxygen.nl) and `Doxybook2` are required. You should install them first.
34
+
35
+ > [!NOTE]
36
+ > The main repository of [Doxybook2](https://github.com/matusnovak/doxybook2) has been archived.
37
+ > For newer features, you can install [GeniusVentures/doxybook2](https://github.com/GeniusVentures/doxybook2).
38
+
39
+ # Usage
40
+
41
+ Add the plugin to your `mkdocs.yml` configuration:
42
+
43
+ ```yaml
44
+ plugins:
45
+ - mkdoxybook2
46
+ ```
47
+
48
+ ## Options
49
+
50
+ You can configure the plugin by adding options to the `mkdocs.yml` configuration:
51
+
52
+ ```yaml
53
+ plugins:
54
+ - mkdoxybook2:
55
+ doxygen-path: # Optional, default to `doxygen`
56
+ doxybook2-path: # Optional, default to `doxybook2`
57
+ output-dir: # Optional, default to `mkdoxygen_output`
58
+ projects: # Define projects to generate documentation for, see details below
59
+ doxy-cfg: # Optional, global Doxygen configuration
60
+ doxybook2-cfg: # Optional, global Doxybook2 configuration
61
+ ```
62
+
63
+ | Option | Description |
64
+ | -------------- | --------------------------------------------------------------------------- |
65
+ | doxygen-path | The path of Doxygen. Default to `doxygen`. |
66
+ | doxybook2-path | The path of Doxybook2. Default to `doxybook2`. |
67
+ | output-dir | The internal documentation output directory. Default to `mkdoxygen_output`. |
68
+ | projects | Define projects to generate documentation for |
69
+ | doxy-cfg | Optional, global Doxygen configuration. |
70
+ | doxybook2-cfg | Optional, global Doxybook2 configuration. |
71
+
72
+ ### Option `projects`
73
+
74
+ Add multiple projects to generate documentation for.
75
+ You can add projects with the following structure:
76
+
77
+ ```yaml
78
+ projects:
79
+ <name>:
80
+ src-dirs: # Source directories to scan for documentation
81
+ full-doc: True # Optional, generate full documentation
82
+ output-dir: # Optional, output directory
83
+ doxy-cfg: # Optional, Doxygen configuration
84
+ doxybook2-cfg: # Optional, Doxybook2 configuration
85
+ ```
86
+
87
+ `doxy-cfg` and `doxybook2-cfg` are optional, and will be merged with the global configuration. They have higher priority than global.
mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/SOURCES.txt ADDED
@@ -0,0 +1,9 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ mkdoxybook2/mkdoxybook2.egg-info/PKG-INFO
5
+ mkdoxybook2/mkdoxybook2.egg-info/SOURCES.txt
6
+ mkdoxybook2/mkdoxybook2.egg-info/dependency_links.txt
7
+ mkdoxybook2/mkdoxybook2.egg-info/entry_points.txt
8
+ mkdoxybook2/mkdoxybook2.egg-info/requires.txt
9
+ mkdoxybook2/mkdoxybook2.egg-info/top_level.txt
mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/entry_points.txt ADDED
@@ -0,0 +1,2 @@
1
+ [mkdocs.plugins]
2
+ mkdoxybook2 = mkdoxybook2.plugin:Doxybook2Plugin
mkdoxybook2-0.1.0/mkdoxybook2/mkdoxybook2.egg-info/requires.txt ADDED
@@ -0,0 +1 @@
1
+ mkdocs>=1.5.0
mkdoxybook2-0.1.0/pyproject.toml ADDED
@@ -0,0 +1,40 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "mkdoxybook2"
7
+ version = "0.1.0"
8
+ description = "A Doxybook2 Helper Plugin for MkDocs documentations"
9
+ readme = "README.md"
10
+ authors = [
11
+ {name = "ACoderOrHacker", email = "ACoderOrHacker@zohomail.com"},
12
+ ]
13
+ license = {text = "MIT"}
14
+ classifiers = [
15
+ "Development Status :: 4 - Beta",
16
+ "Intended Audience :: Developers",
17
+ "License :: OSI Approved :: MIT License",
18
+ "Programming Language :: Python :: 3",
19
+ "Programming Language :: Python :: 3.8",
20
+ "Programming Language :: Python :: 3.9",
21
+ "Programming Language :: Python :: 3.10",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12",
24
+ "Framework :: MkDocs",
25
+ ]
26
+ keywords = ["mkdocs", "doxygen", "doxybook2", "documentation"]
27
+ dependencies = [
28
+ "mkdocs>=1.5.0",
29
+ ]
30
+ requires-python = ">=3.8"
31
+
32
+ [project.urls]
33
+ "Homepage" = "https://github.com/ACoderOrHacker/mkdoxybook2"
34
+ "Bug Tracker" = "https://github.com/ACoderOrHacker/mkdoxybook2/issues"
35
+
36
+ [project.entry-points."mkdocs.plugins"]
37
+ mkdoxybook2 = "mkdoxybook2.plugin:Doxybook2Plugin"
38
+
39
+ [tool.setuptools.packages.find]
40
+ where = ["mkdoxybook2"]
mkdoxybook2-0.1.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+