Add first working version

Author: JakubAndrysek

.github/workflows/deploy-web.yaml

@@ -0,0 +1,27 @@
+name: Build and deploy docs to GitHub Pages
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 'latest'
+      - run: npm install typedoc --save-dev
+      - uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+      - run: python -m pip install -e .\[dev\]
+      - run: make fixRelativeLinkDocs
+      - run: mkdocs gh-deploy --force

.github/workflows/mkdoxy-build-test.yaml

@@ -0,0 +1,33 @@
+name: MkDoxy build all supported Python versions
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      # You can use PyPy versions in python-version.
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 'latest'
+      - name: Install typedoc
+        run: npm install typedoc --save-dev
+      # You can test your matrix by printing the current Python version
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .\[dev\]
+      - name: Build docs
+        run: mkdocs build --clean --verbose

.gitignore

@@ -158,3 +158,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+node_modules/

.idea/.gitignore

@@ -0,0 +1,40 @@
+.PHONY: package release release-test clean reviewCode docs-serve docs-build
+
+# Packaging
+package:
+	rm -f dist/*
+	python3 setup.py sdist bdist_wheel
+
+install: package
+	python3 -m pip install --no-deps --force dist/*.whl
+
+install-dev: package
+	python3 -m pip install --force --editable .
+
+release: package
+	twine upload --repository pypi dist/*
+
+release-test: package
+	twine upload --repository testpypi dist/*
+
+clean:
+	rm -rf dist build
+
+
+fixRelativeLinkDocs:
+	# change ./docs/ to ./
+	sed  's/\.\/docs\//\.\//g' README.md > docs/README.md
+
+# Testing
+reviewCode:
+	sourcery review mkdoxy --in-place
+
+install-dev:
+	python3 -m pip install --force --editable .
+
+# Documentation
+docs-serve: fixRelativeLinkDocs
+	mkdocs serve
+
+docs-build: fixRelativeLinkDocs
+	mkdocs build

.idea/inspectionProfiles/Project_Default.xml

@@ -1 +1,65 @@
-# mkdocs-typedoc
+# Mkdocs-Typedoc Plugin
+
+<p align="center">
+<a href="https://hits.seeyoufarm.com"><img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FJakubAndrysek%2Fmkdocs-typedoc&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=true"/></a>
+<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/blob/main/LICENSE" target="_blank"><img src="https://img.shields.io/github/license/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
+<a href="https://pypi.org/project/mkdocs-typedoc/" target="_blank"><img alt="PyPI" src="https://img.shields.io/pypi/v/mkdocs-typedoc?style=flat-square"></a>
+<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
+<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/forks" target="_blank"><img src="https://img.shields.io/github/forks/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
+<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/issues" target="_blank"><img src="https://img.shields.io/github/issues/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
+<a href="https://github.com/JakubAndrysek/mkdocs-typedoc/discussions" target="_blank"><img src="https://img.shields.io/github/discussions/JakubAndrysek/mkdocs-typedoc?style=flat-square"></a>
+<a href="https://pypistats.org/packages/mkdocs-typedoc" target="_blank"><img src="https://static.pepy.tech/personalized-badge/mkdocs-typedoc?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads"></a>
+</p>
+
+The Mkdocs-Typedoc Plugin is designed to integrate TypeDoc documentation with your MkDocs project.
+
+## Installation
+
+Install the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-typedoc/):
+
+```bash
+pip install mkdocs-typedoc
+```
+
+Ensure that you have [Node.js](https://nodejs.org/en/) installed in your system. If not, you can download it from the official website.
+
+Also, install [TypeDoc](https://typedoc.org/) using [NPM](https://www.npmjs.com/):
+
+```bash
+npm install typedoc --save-dev
+```
+
+## Usage
+
+Add the following lines to your mkdocs.yml:
+
+```yaml
+plugins:
+  - typedoc:
+      source: './ts-examples/@types/*.d.ts'
+      output_dir: 'typedocApi'
+      tsconfig: './ts-examples/tsconfig.json'
+      options: 'typedoc.json'
+      name: 'API Doc'
+```
+
+- `source` (required): The path to your TypeScript source code.
+- `output_dir` (optional): The directory where you want to output your docs. Default is "typedoc".
+- `tsconfig` (required): The path to the tsconfig file for your project.
+- `options` (optional): The path to the typedoc.json options file with more options.
+- `name` (optional): The name for the generated documentation. Default is "TypeDoc API".
+
+The plugin will generate TypeDoc documentation into the output directory specified.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## Do You Enjoy My Work?
+Then definitely consider:
+
+- supporting me on GitHub Sponsors: [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/jakubandrysek)
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1 @@
+typedoc.kubaandrysek.cz

.idea/misc.xml

@@ -0,0 +1,54 @@
+# Mkdocs-Typedoc Plugin
+
+The Mkdocs-Typedoc Plugin is designed to integrate TypeDoc documentation with your MkDocs project.
+
+## Installation
+
+Install the plugin using pip from [PyPI](https://pypi.org/project/mkdocs-typedoc/):
+
+```bash
+pip install mkdocs-typedoc
+```
+
+Ensure that you have [Node.js](https://nodejs.org/en/) installed in your system. If not, you can download it from the official website.
+
+Also, install [TypeDoc](https://typedoc.org/) using [NPM](https://www.npmjs.com/):
+
+```bash
+npm install typedoc --save-dev
+```
+
+## Usage
+
+Add the following lines to your mkdocs.yml:
+
+```yaml
+plugins:
+  - typedoc:
+      source: './ts-examples/@types/*.d.ts'
+      output_dir: 'typedocApi'
+      tsconfig: './ts-examples/tsconfig.json'
+      options: 'typedoc.json'
+      name: 'API Doc'
+```
+
+- `source` (required): The path to your TypeScript source code.
+- `output_dir` (optional): The directory where you want to output your docs. Default is "typedoc".
+- `tsconfig` (required): The path to the tsconfig file for your project.
+- `options` (optional): The path to the typedoc.json options file with more options.
+- `name` (optional): The name for the generated documentation. Default is "TypeDoc API".
+
+The plugin will generate TypeDoc documentation into the output directory specified.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## Do You Enjoy My Work?
+Then definitely consider:
+
+- supporting me on GitHub Sponsors: [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/jakubandrysek)
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)