Skip to content

Commit ab82e01

Browse files
committed
Siva | remove same-dir and use snippets extension for documentation
1 parent 0450deb commit ab82e01

6 files changed

Lines changed: 14 additions & 6 deletions

File tree

docs/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--8<-- "CHANGELOG.md"
2+

docs/CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--8<-- "CONTRIBUTING.md"
2+

docs/LICENSE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--8<-- "LICENSE"
2+

docs/PROJECT-README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--8<-- "README.md"
2+

mkdocs.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,18 @@ site_url: "https://pypi.org/project/nestedutils"
66
repo_name: "ysskrishna/nestedutils"
77
repo_url: "https://github.com/ysskrishna/nestedutils"
88
copyright: Copyright &copy; 2025 Y. Siva Sai Krishna
9-
docs_dir: .
10-
site_dir: ../site
9+
docs_dir: docs
1110

1211

1312
nav:
14-
- Project Readme: README.md
15-
- API Reference: docs/index.md
13+
- Project Readme: PROJECT-README.md
14+
- API Reference: index.md
1615
- Contributing: CONTRIBUTING.md
1716
- Changelog: CHANGELOG.md
17+
- License: LICENSE.md
1818

1919
plugins:
2020
- search
21-
- same-dir
2221
- mkdocstrings:
2322
handlers:
2423
python:
@@ -42,6 +41,8 @@ markdown_extensions:
4241
- admonition
4342
- toc:
4443
permalink: true
44+
- pymdownx.snippets:
45+
base_path: .
4546

4647
extra:
4748
social:

pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ author_linkedin = "https://linkedin.com/in/ysskrishna"
8181
dev = [
8282
"mkdocs>=1.6.1",
8383
"mkdocs-material>=9.7.1",
84-
"mkdocs-same-dir>=0.1.3",
8584
"mkdocstrings>=0.26.1",
8685
"mkdocstrings-python>=1.11.1",
8786
"pytest>=7.4.4",

0 commit comments

Comments
 (0)