bst-docs 0.0.1__tar.gz → 0.0.2__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 (17) hide show
  1. {bst_docs-0.0.1 → bst_docs-0.0.2}/PKG-INFO +6 -10
  2. {bst_docs-0.0.1 → bst_docs-0.0.2}/README.md +4 -7
  3. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/build.py +1 -1
  4. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/PKG-INFO +6 -10
  5. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/requires.txt +1 -2
  6. {bst_docs-0.0.1 → bst_docs-0.0.2}/pyproject.toml +2 -3
  7. {bst_docs-0.0.1 → bst_docs-0.0.2}/LICENSE +0 -0
  8. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/__init__.py +0 -0
  9. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/__main__.py +0 -0
  10. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/element.py +0 -0
  11. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/load_contents.py +0 -0
  12. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/render.py +0 -0
  13. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/SOURCES.txt +0 -0
  14. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/dependency_links.txt +0 -0
  15. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/entry_points.txt +0 -0
  16. {bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/top_level.txt +0 -0
  17. {bst_docs-0.0.1 → bst_docs-0.0.2}/setup.cfg +0 -0
{bst_docs-0.0.1 → bst_docs-0.0.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: bst-docs
3
- Version: 0.0.1
3
+ Version: 0.0.2
4
4
  Summary: API Reference Generator for Buildstream Projects
5
5
  Author-email: Aedan McHale <aedan.mchale@gmail.com>
6
6
  License-Expression: MIT
@@ -16,13 +16,11 @@ Classifier: Topic :: Software Development :: Build Tools
16
16
  Requires-Python: >=3.12
17
17
  Description-Content-Type: text/markdown
18
18
  License-File: LICENSE
19
- Requires-Dist: buildstream>=2.7.0
20
19
  Requires-Dist: click>=8.4.1
21
20
  Requires-Dist: gitpython>=3.1.50
22
21
  Requires-Dist: mdformat>=1.0.0
23
22
  Requires-Dist: pyyaml>=6.0.3
24
23
  Requires-Dist: tqdm>=4.68.2
25
- Requires-Dist: ty>=0.0.43
26
24
  Requires-Dist: validators>=0.35.0
27
25
  Provides-Extra: dev
28
26
  Requires-Dist: build>=1.5.0; extra == "dev"
@@ -30,11 +28,13 @@ Requires-Dist: prek>=0.4.4; extra == "dev"
30
28
  Requires-Dist: ruff>=0.15.15; extra == "dev"
31
29
  Requires-Dist: twine>=6.2.0; extra == "dev"
32
30
  Requires-Dist: zensical>=0.0.44; extra == "dev"
31
+ Requires-Dist: ty>=0.0.43; extra == "dev"
33
32
  Dynamic: license-file
34
33
 
35
34
  # bst-docs
36
35
 
37
- This is a
36
+ This is a API reference generator in the vein of projects like [pydoc](https://docs.python.org/3/library/pydoc.html) or [doxygen](https://www.doxygen.nl/index.html).
37
+ The goal is to generate markdown documents which describe elements within a [Buildstream Project](https://buildstream.build/), ideally for inclusion within hosted documentation.
38
38
 
39
39
  ## Usage
40
40
 
@@ -54,6 +54,8 @@ An example zensical.toml has been provided to view the results in `./output`, to
54
54
  ```shell
55
55
  Usage: bst-docs build [OPTIONS] [PATH]
56
56
 
57
+ Generate documentation for a BuildStream project.
58
+
57
59
  Options:
58
60
  --depth INTEGER Depth of network crawling to perform
59
61
  --output TEXT Destination folder for markdown files
@@ -61,11 +63,5 @@ Options:
61
63
  --html-elements BOOLEAN If true, html elements will be embedded in markdown
62
64
  files otherwise pure Commonmark markdown will be
63
65
  used
64
- --overwrite BOOLEAN Overwrite output directory if true, otherwise
65
- errors if output files exist
66
66
  --help Show this message and exit.
67
67
  ```
68
-
69
- ## Design Choices
70
-
71
- - Should be possible to render everything as MD, html is for nicenesses
{bst_docs-0.0.1 → bst_docs-0.0.2}/README.md RENAMED
@@ -1,6 +1,7 @@
1
1
  # bst-docs
2
2
 
3
- This is a
3
+ This is a API reference generator in the vein of projects like [pydoc](https://docs.python.org/3/library/pydoc.html) or [doxygen](https://www.doxygen.nl/index.html).
4
+ The goal is to generate markdown documents which describe elements within a [Buildstream Project](https://buildstream.build/), ideally for inclusion within hosted documentation.
4
5
 
5
6
  ## Usage
6
7
 
@@ -20,6 +21,8 @@ An example zensical.toml has been provided to view the results in `./output`, to
20
21
  ```shell
21
22
  Usage: bst-docs build [OPTIONS] [PATH]
22
23
 
24
+ Generate documentation for a BuildStream project.
25
+
23
26
  Options:
24
27
  --depth INTEGER Depth of network crawling to perform
25
28
  --output TEXT Destination folder for markdown files
@@ -27,11 +30,5 @@ Options:
27
30
  --html-elements BOOLEAN If true, html elements will be embedded in markdown
28
31
  files otherwise pure Commonmark markdown will be
29
32
  used
30
- --overwrite BOOLEAN Overwrite output directory if true, otherwise
31
- errors if output files exist
32
33
  --help Show this message and exit.
33
34
  ```
34
-
35
- ## Design Choices
36
-
37
- - Should be possible to render everything as MD, html is for nicenesses
{bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/build.py RENAMED
@@ -35,7 +35,7 @@ from bst_docs.load_contents import load_project
35
35
  required=False,
36
36
  help=(
37
37
  "If true, html elements will be embedded in markdown files"
38
- "otherwise pure Commonmark markdown will be used"
38
+ " otherwise pure Commonmark markdown will be used"
39
39
  ),
40
40
  )
41
41
  @click.argument("path", default=".")
{bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: bst-docs
3
- Version: 0.0.1
3
+ Version: 0.0.2
4
4
  Summary: API Reference Generator for Buildstream Projects
5
5
  Author-email: Aedan McHale <aedan.mchale@gmail.com>
6
6
  License-Expression: MIT
@@ -16,13 +16,11 @@ Classifier: Topic :: Software Development :: Build Tools
16
16
  Requires-Python: >=3.12
17
17
  Description-Content-Type: text/markdown
18
18
  License-File: LICENSE
19
- Requires-Dist: buildstream>=2.7.0
20
19
  Requires-Dist: click>=8.4.1
21
20
  Requires-Dist: gitpython>=3.1.50
22
21
  Requires-Dist: mdformat>=1.0.0
23
22
  Requires-Dist: pyyaml>=6.0.3
24
23
  Requires-Dist: tqdm>=4.68.2
25
- Requires-Dist: ty>=0.0.43
26
24
  Requires-Dist: validators>=0.35.0
27
25
  Provides-Extra: dev
28
26
  Requires-Dist: build>=1.5.0; extra == "dev"
@@ -30,11 +28,13 @@ Requires-Dist: prek>=0.4.4; extra == "dev"
30
28
  Requires-Dist: ruff>=0.15.15; extra == "dev"
31
29
  Requires-Dist: twine>=6.2.0; extra == "dev"
32
30
  Requires-Dist: zensical>=0.0.44; extra == "dev"
31
+ Requires-Dist: ty>=0.0.43; extra == "dev"
33
32
  Dynamic: license-file
34
33
 
35
34
  # bst-docs
36
35
 
37
- This is a
36
+ This is a API reference generator in the vein of projects like [pydoc](https://docs.python.org/3/library/pydoc.html) or [doxygen](https://www.doxygen.nl/index.html).
37
+ The goal is to generate markdown documents which describe elements within a [Buildstream Project](https://buildstream.build/), ideally for inclusion within hosted documentation.
38
38
 
39
39
  ## Usage
40
40
 
@@ -54,6 +54,8 @@ An example zensical.toml has been provided to view the results in `./output`, to
54
54
  ```shell
55
55
  Usage: bst-docs build [OPTIONS] [PATH]
56
56
 
57
+ Generate documentation for a BuildStream project.
58
+
57
59
  Options:
58
60
  --depth INTEGER Depth of network crawling to perform
59
61
  --output TEXT Destination folder for markdown files
@@ -61,11 +63,5 @@ Options:
61
63
  --html-elements BOOLEAN If true, html elements will be embedded in markdown
62
64
  files otherwise pure Commonmark markdown will be
63
65
  used
64
- --overwrite BOOLEAN Overwrite output directory if true, otherwise
65
- errors if output files exist
66
66
  --help Show this message and exit.
67
67
  ```
68
-
69
- ## Design Choices
70
-
71
- - Should be possible to render everything as MD, html is for nicenesses
{bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs.egg-info/requires.txt RENAMED
@@ -1,10 +1,8 @@
1
- buildstream>=2.7.0
2
1
  click>=8.4.1
3
2
  gitpython>=3.1.50
4
3
  mdformat>=1.0.0
5
4
  pyyaml>=6.0.3
6
5
  tqdm>=4.68.2
7
- ty>=0.0.43
8
6
  validators>=0.35.0
9
7
 
10
8
  [dev]
@@ -13,3 +11,4 @@ prek>=0.4.4
13
11
  ruff>=0.15.15
14
12
  twine>=6.2.0
15
13
  zensical>=0.0.44
14
+ ty>=0.0.43
{bst_docs-0.0.1 → bst_docs-0.0.2}/pyproject.toml RENAMED
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "bst-docs"
3
- version = "0.0.1"
3
+ version = "0.0.2"
4
4
  readme = "README.md"
5
5
  authors = [{ name = "Aedan McHale", email = "aedan.mchale@gmail.com" }]
6
6
  license = "MIT"
@@ -17,13 +17,11 @@ classifiers = [
17
17
  description = "API Reference Generator for Buildstream Projects"
18
18
  requires-python = ">=3.12"
19
19
  dependencies = [
20
- "buildstream>=2.7.0",
21
20
  "click>=8.4.1",
22
21
  "gitpython>=3.1.50",
23
22
  "mdformat>=1.0.0",
24
23
  "pyyaml>=6.0.3",
25
24
  "tqdm>=4.68.2",
26
- "ty>=0.0.43",
27
25
  "validators>=0.35.0",
28
26
  ]
29
27
 
@@ -37,6 +35,7 @@ dev = [
37
35
  "ruff>=0.15.15",
38
36
  "twine>=6.2.0",
39
37
  "zensical>=0.0.44",
38
+ "ty>=0.0.43",
40
39
  ]
41
40
 
42
41
  [project.urls]
{bst_docs-0.0.1 → bst_docs-0.0.2}/LICENSE RENAMED
File without changes
{bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/__init__.py RENAMED
File without changes
{bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/__main__.py RENAMED
File without changes
{bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/element.py RENAMED
File without changes
{bst_docs-0.0.1 → bst_docs-0.0.2}/bst_docs/render.py RENAMED
File without changes
{bst_docs-0.0.1 → bst_docs-0.0.2}/setup.cfg RENAMED
File without changes