Skip to content

Commit 0ed5c6a

Browse files
Merge pull request #640 from itdependsnetworks/fix-docs
Fix docs
2 parents 4e2f81a + f5d7318 commit 0ed5c6a

File tree

5 files changed

+223
-60
lines changed

5 files changed

+223
-60
lines changed

docs/requirements.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
mkdocs==1.6.0
2-
# Material for MkDocs theme
32
mkdocs-material==9.5.32
4-
mkdocs-python-classy==0.1.3
5-
# Render custom markdown for version added/changed/remove notes
6-
mkdocs-version-annotations==1.0.0
7-
# Automatic documentation from sources, for MkDocs
8-
mkdocstrings==0.25.2
3+
markdown-version-annotations==1.0.1
4+
griffe==1.1.1
95
mkdocstrings-python==1.10.8
10-
griffe==1.1.1
6+
mkdocstrings==0.25.2
7+
mkdocs-autorefs==1.2.0
8+
# Unique requirements
9+
mkdocs-python-classy==0.1.3

docs/user/lib_use_cases_lib_mapper.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ Another use case could be using an example like the above in an Ansible filter.
4141

4242
## Aerleon Mapper
4343

44-
--8<-- "docs/user/lib_mapper/aerleon.md
44+
--8<-- "docs/user/lib_mapper/aerleon.md"
4545

4646
## Reverse Aerleon Mapper
4747

48-
--8<-- "docs/user/lib_mapper/aerleon_reverse.md
48+
--8<-- "docs/user/lib_mapper/aerleon_reverse.md"
4949

5050
## Ansible Mapper
5151

@@ -57,19 +57,19 @@ Another use case could be using an example like the above in an Ansible filter.
5757

5858
## Capirca Mapper
5959

60-
--8<-- "docs/user/lib_mapper/capirca.md
60+
--8<-- "docs/user/lib_mapper/capirca.md"
6161

6262
## Reverse Capirca Mapper
6363

64-
--8<-- "docs/user/lib_mapper/capirca_reverse.md
64+
--8<-- "docs/user/lib_mapper/capirca_reverse.md"
6565

6666
## DNA Center Mapper
6767

68-
--8<-- "docs/user/lib_mapper/dna_center.md
68+
--8<-- "docs/user/lib_mapper/dna_center.md"
6969

7070
## Reverse DNA Center Mapper
7171

72-
--8<-- "docs/user/lib_mapper/dna_center_reverse.md
72+
--8<-- "docs/user/lib_mapper/dna_center_reverse.md"
7373

7474
## Forward Networks Mapper
7575

@@ -122,11 +122,11 @@ Another use case could be using an example like the above in an Ansible filter.
122122

123123
## NIST Mapper
124124

125-
--8<-- "docs/user/lib_mapper/nist.md
125+
--8<-- "docs/user/lib_mapper/nist.md"
126126

127127
## Reverse NIST Mapper
128128

129-
--8<-- "docs/user/lib_mapper/nist_reverse.md
129+
--8<-- "docs/user/lib_mapper/nist_reverse.md"
130130

131131
## PyATS Mapper
132132

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ extra:
6969
link: "https://twitter.com/networktocode"
7070
name: "Network to Code Twitter"
7171
markdown_extensions:
72+
- "markdown_version_annotations":
73+
admonition_tag: "???"
7274
- "admonition"
7375
- "toc":
7476
permalink: true
@@ -82,7 +84,6 @@ markdown_extensions:
8284
- "footnotes"
8385
plugins:
8486
- "search"
85-
- "mkdocs-version-annotations"
8687
- "mkdocs-python-classy":
8788
classy_strategy: "subclass"
8889
classy_modules:

0 commit comments

Comments
 (0)