From f7fa0272b9a47333486ce088f76021ab9575de36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Mazzucotelli?= Date: Mon, 1 Jun 2020 16:58:58 +0200 Subject: [PATCH] docs: Update docs for new parsers layout --- .../developers/test_suite/test_parsers/test_docstrings.md | 1 - .../test_parsers/test_docstrings/test_google.md | 1 + docs/reference/parsers/docstrings.md | 1 - docs/reference/parsers/docstrings/__init__.md | 1 + docs/reference/parsers/docstrings/base.md | 1 + docs/reference/parsers/docstrings/google.md | 1 + mkdocs.yml | 8 ++++++-- 7 files changed, 10 insertions(+), 4 deletions(-) delete mode 100644 docs/developers/test_suite/test_parsers/test_docstrings.md create mode 100644 docs/developers/test_suite/test_parsers/test_docstrings/test_google.md delete mode 100644 docs/reference/parsers/docstrings.md create mode 100644 docs/reference/parsers/docstrings/__init__.md create mode 100644 docs/reference/parsers/docstrings/base.md create mode 100644 docs/reference/parsers/docstrings/google.md diff --git a/docs/developers/test_suite/test_parsers/test_docstrings.md b/docs/developers/test_suite/test_parsers/test_docstrings.md deleted file mode 100644 index d0612a3..0000000 --- a/docs/developers/test_suite/test_parsers/test_docstrings.md +++ /dev/null @@ -1 +0,0 @@ -::: tests.test_parsers.test_docstrings diff --git a/docs/developers/test_suite/test_parsers/test_docstrings/test_google.md b/docs/developers/test_suite/test_parsers/test_docstrings/test_google.md new file mode 100644 index 0000000..031cd7f --- /dev/null +++ b/docs/developers/test_suite/test_parsers/test_docstrings/test_google.md @@ -0,0 +1 @@ +::: tests.test_parsers.test_docstrings.test_google diff --git a/docs/reference/parsers/docstrings.md b/docs/reference/parsers/docstrings.md deleted file mode 100644 index 841e24d..0000000 --- a/docs/reference/parsers/docstrings.md +++ /dev/null @@ -1 +0,0 @@ -::: pytkdocs.parsers.docstrings diff --git a/docs/reference/parsers/docstrings/__init__.md b/docs/reference/parsers/docstrings/__init__.md new file mode 100644 index 0000000..234c314 --- /dev/null +++ b/docs/reference/parsers/docstrings/__init__.md @@ -0,0 +1 @@ +::: pytkdocs.parsers.docstrings.__init__ diff --git a/docs/reference/parsers/docstrings/base.md b/docs/reference/parsers/docstrings/base.md new file mode 100644 index 0000000..00c65a4 --- /dev/null +++ b/docs/reference/parsers/docstrings/base.md @@ -0,0 +1 @@ +::: pytkdocs.parsers.docstrings.base diff --git a/docs/reference/parsers/docstrings/google.md b/docs/reference/parsers/docstrings/google.md new file mode 100644 index 0000000..553d7c5 --- /dev/null +++ b/docs/reference/parsers/docstrings/google.md @@ -0,0 +1 @@ +::: pytkdocs.parsers.docstrings.google diff --git a/mkdocs.yml b/mkdocs.yml index af49daf..d01da6c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,10 @@ nav: - parsers: - __init__.py: "reference/parsers/__init__.md" - attributes.py: "reference/parsers/attributes.md" - - docstrings.py: "reference/parsers/docstrings.md" + - docstrings: + - __init__.py: "reference/parsers/docstrings/__init__.md" + - base.py: "reference/parsers/docstrings/base.md" + - google.py: "reference/parsers/docstrings/google.md" - properties.py: "reference/properties.md" - serializer.py: "reference/serializer.md" - Contributing: "contributing.md" @@ -37,7 +40,8 @@ nav: - test_objects.py: "developers/test_suite/test_objects.md" - test_parsers: - test_attributes.py: "developers/test_suite/test_parsers/test_attributes.md" - - test_docstrings.py: "developers/test_suite/test_parsers/test_docstrings.md" + - test_docstrings: + - test_google.py: "developers/test_suite/test_parsers/test_docstrings/test_google.md" - test_properties.py: "developers/test_suite/test_properties.md" - test_serializer.py: "developers/test_suite/test_serializer.md" - Code of Conduct: "code_of_conduct.md"