Skip to content

Commit 62ed396

Browse files
author
Jimisola Laursen
committed
docs: streamline nav and page structure
- Separate nav items instead of single include-based page - Merge description.adoc content into index.adoc - Remove licence.adoc, add inline license to index.adoc - Fix markdown fenced blocks to AsciiDoc source blocks - Add installation.adoc to nav - Change nav label from Start to Overview Signed-off-by: jimisola <jimisola@jimisola.com>
1 parent 833f4ed commit 62ed396

6 files changed

Lines changed: 30 additions & 30 deletions

File tree

docs/modules/ROOT/nav.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
* xref:index.adoc[Start]
2-
* xref:usage.adoc[Usage]
1+
* xref:index.adoc[Overview]
2+
* xref:installation.adoc[Installation]
3+
* xref:usage.adoc[Usage]

docs/modules/ROOT/pages/description.adoc

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/modules/ROOT/pages/index.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Reqstool Python Decorators
22

3-
include::description.adoc[]
3+
This provides decorators and collecting of decorated code, formatting it and writing to yaml file.
44

5-
include::installation.adoc[]
5+
== License
66

7-
include::licence.adoc[]
7+
MIT License.

docs/modules/ROOT/pages/installation.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
The package name is `reqstool-python-decorators`.
44

5-
* Using pip:
6-
7-
```
5+
[source,bash]
6+
----
87
pip install reqstool-python-decorators
9-
```
8+
----

docs/modules/ROOT/pages/licence.adoc

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/modules/ROOT/pages/usage.adoc

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,54 +4,60 @@
44

55
* Hatch
66

7-
```
7+
[source,toml]
8+
----
89
dependencies = [
910
"reqstool-python-decorators == <version>"
1011
]
11-
```
12+
----
1213

1314
* Poetry
1415

15-
```
16+
[source,toml]
17+
----
1618
[tool.poetry.dependencies]
1719
reqstool-python-decorators = "<version>"
18-
```
20+
----
1921

2022
=== Decorators
2123

2224
Import decorators:
2325

24-
```
26+
[source,python]
27+
----
2528
from reqstool_python_decorators.decorators.decorators import Requirements, SVCs
26-
```
29+
----
2730

2831
Example usage of the decorators:
2932

30-
```python
33+
[source,python]
34+
----
3135
@Requirements("REQ_111", "REQ_222")
3236
def somefunction():
33-
```
37+
----
3438

35-
```python
39+
[source,python]
40+
----
3641
@SVCs("SVC_111", "SVC_222")
3742
def test_somefunction():
38-
```
43+
----
3944

4045
=== Processor
4146

4247
Import processor:
4348

44-
```
49+
[source,python]
50+
----
4551
from reqstool_python_decorators.processors.decorator_processor import DecoratorProcessor
46-
```
52+
----
4753

4854
Main function to collect decorators data and generate yaml file:
4955

50-
```
56+
[source,python]
57+
----
5158
process_decorated_data(path_to_python_files, output_file)
52-
```
59+
----
5360

5461
`path_to_python_files` is the directories to search through to find decorated code.
5562

5663
(Optional) `output_file` is output file(path) the yaml file is stored to. Default is `/build/reqstool/annotations.yml`.
57-

0 commit comments

Comments
 (0)