Merge pull request #22 from Anselmoo/Fixed-docs

Update docs and setup

Author: Anselmoo

.github/workflows/cd.yml

@@ -19,14 +19,14 @@ jobs:
     strategy:
       matrix:
         python-version:
-          - 3.6
-          - 3.7
+          #- 3.6
+          #- 3.7
           - 3.8
-          - 3.9
+          #- 3.9
         os:
           - ubuntu-latest
-          - macOS-latest
-          - windows-latest
+          #- macOS-latest
+          #- windows-latest
         arch:
           - x64
     steps:

LICENSE

@@ -199,3 +199,8 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
+
+---
+
+mkdocstrings-sourcelink is inspired and partially derived, from keras-autodoc
+extension https://github.com/keras-team/keras-autodoc.

README.md

@@ -4,6 +4,8 @@
 [![codecov](https://codecov.io/gh/AI2Business/mkdocstrings-sourcelink/branch/main/graph/badge.svg?token=DKE0SHCRF7)](https://codecov.io/gh/AI2Business/mkdocstrings-sourcelink)
 [![Code Style: Black](https://img.shields.io/badge/code%20style-black-black.svg)](https://github.com/ambv/black)
 [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/AI2Business/mkdocstrings-sourcelink.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/AI2Business/mkdocstrings-sourcelink/context:python)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocstrings-sourcelink?logo=python&logoColor=yellow)](https://pypi.org/project/mkdocstrings-sourcelink/)
+[![PyPI](https://img.shields.io/pypi/v/mkdocstrings-sourcelink?logo=PyPi&logoColor=yellow)](https://pypi.org/project/mkdocstrings-sourcelink/)
 
 # mkdocstrings-sourcelink
 

docs/Pipfile

@@ -16,7 +16,6 @@ mkdocs-minify-plugin = "*"
 mkdocs-redirects = "*"
 mkdocs-git-revision-date-plugin = "*"
 pymdown-extensions = "*"
-mkdocs-pymdownx-material-extras = "*"
 mkdocs-git-revision-date-localized-plugin = "*"
 pyspelling = "*"
 

docs/Pipfile.lock

@@ -24,7 +24,6 @@ mkdocs-macros-test==0.1.0
 mkdocs-material-extensions==1.0.1; python_version >= '3.5'
 mkdocs-material==6.2.8
 mkdocs-minify-plugin==0.4.0
-mkdocs-pymdownx-material-extras==1.1.3
 mkdocs-redirects==1.0.1
 mkdocs==1.1.2
 mkdocstrings==0.14.0

docs/doc-requirements.txt

@@ -30,7 +30,11 @@
         ],
     },
 }
-markdown_files = {"HOME": {"index.md": ["../README.md"]}}
+markdown_files = {
+    "HOME": {"index.md": ["../README.md"]},
+    "CONTRIBUTING": {"contributing.md": ["../CONTRIBUTING.md"]},
+    "LICENSE": {"license.md": ["../LICENSE"]},
+}
 root = Path(__file__).resolve().parents[1]
 MkDocGenerator(
     root / "docs" / "src",

docs/generate_docs.py

@@ -5,7 +5,7 @@ site_author: AI2Business & coworkers
 
 repo_url: https://github.com/AI2Business/mkdocstrings-sourcelink
 repo_name: mkdocstrings-sourcelink
-edit_uri: edit/main/docs/src
+edit_uri: edit/main/docs/
 
 # Copyright
 copyright: Copyright © 2021 - AI2Business
@@ -120,7 +120,6 @@ extra:
 
 plugins:
   - search
-  - mkdocs_pymdownx_material_extras
   - macros
   - mkdocstrings:
       watch:
@@ -136,4 +135,7 @@ nav:
   - Documentation:
     - Automatic Doc Generator: auto_generator.md
     - Tools: toolbox.md
-  - API: api.md
+  - API: api.md
+  - About:
+      - Contribution: contributing.md
+      - LICENSE: license.md

docs/mkdocs.yml

@@ -35,7 +35,11 @@ pages = {
         ],
     },
 }
-markdown_files = {"HOME": {"index.md": ["../README.md"]}}
+markdown_files = {
+    "HOME": {"index.md": ["../README.md"]},
+    "CONTRIBUTING": {"contributing.md": ["../CONTRIBUTING.md"]},
+    "LICENSE": {"license.md": ["../LICENSE"]},
+}
 root = Path(__file__).resolve().parents[1]
 MkDocGenerator(
     root / "docs" / "src",
@@ -47,4 +51,6 @@ MkDocGenerator(
 ).generate
 ```
 
-And will generate the [docs](https://ai2business.github.io/mkdocstrings-sourcelink/)
+And will generate the [docs](https://ai2business.github.io/mkdocstrings-sourcelink/)
+
+> Note the docs will not be modified via `edit`, they will be modified in the docstrings of the source code.

docs/tmp/example.md

@@ -241,7 +241,11 @@ def generate(self) -> None:
                 },
             }
             # Define the dictionary for the importing existing markdown files.
-            >>> markdown_files = {"HOME": {"index.md": ["../README.md"]}}
+            >>> markdown_files = {
+                "HOME": {"index.md": ["../README.md"]},
+                "CONTRIBUTING": {"contributing.md": ["../CONTRIBUTING.md"]},
+                "LICENSE": {"license.md": ["../LICENSE"]},
+            }
             >>> root = Path(__file__).resolve().parents[1]
             # Make use of the generate poperty of MkDocGenerator
             >>> MkDocGenerator(