nmk-doc 0.2.0__tar.gz → 0.3.1__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 (21) hide show
  1. {nmk-doc-0.2.0/src/nmk_doc.egg-info → nmk-doc-0.3.1}/PKG-INFO +4 -4
  2. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/README.md +3 -3
  3. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/setup.cfg +1 -1
  4. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/badges.yml +1 -1
  5. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/doc.yml +5 -1
  6. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/plugin-defs.yml +1 -1
  7. {nmk-doc-0.2.0 → nmk-doc-0.3.1/src/nmk_doc.egg-info}/PKG-INFO +4 -4
  8. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/LICENSE +0 -0
  9. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/setup.py +0 -0
  10. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/__init__.py +0 -0
  11. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/builders.py +0 -0
  12. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/path.yml +0 -0
  13. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/plugin.yml +0 -0
  14. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/resolvers.py +0 -0
  15. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/templates/__init__.py +0 -0
  16. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/templates/config.py.jinja +0 -0
  17. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/templates/readthedocs.yaml.jinja +0 -0
  18. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc.egg-info/SOURCES.txt +0 -0
  19. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc.egg-info/dependency_links.txt +0 -0
  20. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc.egg-info/requires.txt +0 -0
  21. {nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc.egg-info/top_level.txt +0 -0
{nmk-doc-0.2.0/src/nmk_doc.egg-info → nmk-doc-0.3.1}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: nmk-doc
3
- Version: 0.2.0
3
+ Version: 0.3.1
4
4
  Summary: Documentation handling plugin for nmk build system
5
5
  Home-page: https://github.com/dynod/nmk-doc
6
6
  Author: The dynod project
@@ -18,7 +18,7 @@ Description: # nmk-doc
18
18
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
19
19
  [![Flake8 analysis result](https://img.shields.io/badge/flake8-0-green)](https://flake8.pycqa.org/)
20
20
  [![Code coverage](https://img.shields.io/codecov/c/github/dynod/nmk-doc)](https://app.codecov.io/gh/dynod/nmk-doc)
21
- [![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/en/stable/?badge=stable)
21
+ [![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/)
22
22
  <!-- NMK-BADGES-END -->
23
23
 
24
24
  This plugin provide tasks to build documentation using the [Sphinx tool](https://www.sphinx-doc.org/).
@@ -26,14 +26,14 @@ Description: # nmk-doc
26
26
  ## Usage
27
27
 
28
28
  To use this plugin in your **`nmk`** project, insert this reference:
29
- ```
29
+ ```yaml
30
30
  refs:
31
31
  - pip://nmk-doc!plugin.yml
32
32
  ```
33
33
 
34
34
  ## Documentation
35
35
 
36
- This plugin documentation is available [here](https://nmk-doc.readthedocs.io/en/stable)
36
+ This plugin documentation is available [here](https://nmk-doc.readthedocs.io/)
37
37
 
38
38
  ## Issues
39
39
 
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/README.md RENAMED
@@ -10,7 +10,7 @@ Documentation handling plugin for nmk build system
10
10
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
11
11
  [![Flake8 analysis result](https://img.shields.io/badge/flake8-0-green)](https://flake8.pycqa.org/)
12
12
  [![Code coverage](https://img.shields.io/codecov/c/github/dynod/nmk-doc)](https://app.codecov.io/gh/dynod/nmk-doc)
13
- [![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/en/stable/?badge=stable)
13
+ [![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/)
14
14
  <!-- NMK-BADGES-END -->
15
15
 
16
16
  This plugin provide tasks to build documentation using the [Sphinx tool](https://www.sphinx-doc.org/).
@@ -18,14 +18,14 @@ This plugin provide tasks to build documentation using the [Sphinx tool](https:/
18
18
  ## Usage
19
19
 
20
20
  To use this plugin in your **`nmk`** project, insert this reference:
21
- ```
21
+ ```yaml
22
22
  refs:
23
23
  - pip://nmk-doc!plugin.yml
24
24
  ```
25
25
 
26
26
  ## Documentation
27
27
 
28
- This plugin documentation is available [here](https://nmk-doc.readthedocs.io/en/stable)
28
+ This plugin documentation is available [here](https://nmk-doc.readthedocs.io/)
29
29
 
30
30
  ## Issues
31
31
 
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/setup.cfg RENAMED
@@ -15,7 +15,7 @@ exclude =
15
15
  name = nmk-doc
16
16
  author = The dynod project
17
17
  maintainer = The dynod project
18
- version = 0.2.0
18
+ version = 0.3.1
19
19
  long_description = file: README.md
20
20
  long_description_content_type = text/markdown
21
21
  license = Mozilla Public License Version 2.0
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/badges.yml RENAMED
@@ -3,5 +3,5 @@ config:
3
3
  badges:
4
4
  - alt: "Documentation Status"
5
5
  img: https://readthedocs.org/projects/${projectName}/badge/?version=stable
6
- url: https://${projectName}.readthedocs.io/en/stable/?badge=stable
6
+ url: https://${projectName}.readthedocs.io/
7
7
  if: ${docInputs}
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/doc.yml RENAMED
@@ -19,6 +19,9 @@ config:
19
19
  - myst_parser
20
20
  - sphinx_rtd_theme
21
21
 
22
+ # Extendable list for venv deps for projects which may need for other sphinx extensions
23
+ docExtensionsVenvDeps: []
24
+
22
25
  # Project name (default: shared name config)
23
26
  docName: ${projectName}
24
27
 
@@ -54,11 +57,12 @@ config:
54
57
  # Template file for ReadTheDocs automated build config
55
58
  docRTDConfigTemplate: ${BASEDIR}/templates/readthedocs.yaml.jinja
56
59
 
57
- # Additional venv dependencies (sphinx itself + plugins)
60
+ # Additional venv dependencies (sphinx itself + plugins + external contributions)
58
61
  venvPkgDeps:
59
62
  - sphinx
60
63
  - sphinx_rtd_theme
61
64
  - myst-parser
65
+ - ${docExtensionsVenvDeps}
62
66
 
63
67
  tasks:
64
68
 
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/plugin-defs.yml RENAMED
@@ -17,7 +17,7 @@ config:
17
17
 
18
18
  # Plugin help links dict
19
19
  nmkPluginsDocs:
20
- nmk-doc: https://nmk-doc.readthedocs.io/en/stable
20
+ nmk-doc: https://nmk-doc.readthedocs.io/
21
21
 
22
22
  # Extra VSCode words for CSpell extension
23
23
  vscodeSettingsItems:
{nmk-doc-0.2.0 → nmk-doc-0.3.1/src/nmk_doc.egg-info}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: nmk-doc
3
- Version: 0.2.0
3
+ Version: 0.3.1
4
4
  Summary: Documentation handling plugin for nmk build system
5
5
  Home-page: https://github.com/dynod/nmk-doc
6
6
  Author: The dynod project
@@ -18,7 +18,7 @@ Description: # nmk-doc
18
18
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
19
19
  [![Flake8 analysis result](https://img.shields.io/badge/flake8-0-green)](https://flake8.pycqa.org/)
20
20
  [![Code coverage](https://img.shields.io/codecov/c/github/dynod/nmk-doc)](https://app.codecov.io/gh/dynod/nmk-doc)
21
- [![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/en/stable/?badge=stable)
21
+ [![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/)
22
22
  <!-- NMK-BADGES-END -->
23
23
 
24
24
  This plugin provide tasks to build documentation using the [Sphinx tool](https://www.sphinx-doc.org/).
@@ -26,14 +26,14 @@ Description: # nmk-doc
26
26
  ## Usage
27
27
 
28
28
  To use this plugin in your **`nmk`** project, insert this reference:
29
- ```
29
+ ```yaml
30
30
  refs:
31
31
  - pip://nmk-doc!plugin.yml
32
32
  ```
33
33
 
34
34
  ## Documentation
35
35
 
36
- This plugin documentation is available [here](https://nmk-doc.readthedocs.io/en/stable)
36
+ This plugin documentation is available [here](https://nmk-doc.readthedocs.io/)
37
37
 
38
38
  ## Issues
39
39
 
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/LICENSE RENAMED
File without changes
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/setup.py RENAMED
File without changes
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/__init__.py RENAMED
File without changes
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/builders.py RENAMED
File without changes
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/path.yml RENAMED
File without changes
{nmk-doc-0.2.0 → nmk-doc-0.3.1}/src/nmk_doc/plugin.yml RENAMED
File without changes