Release v1.1.1

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==1.1.1

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull althack/mkdocs-simple-plugin:v1.1.1

See it on dockerhub: https://hub.docker.com/repository/docker/althack/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v1.1.1

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🐛 Bug Fixes

• Fix docker action fatal: unsafe repository (#310) @athackst
• Fix/requirements (#312) @athackst

🧰 Maintenance

• revert pre-hook due to continuous recompile during serve (#311) @athackst
• Use mkdocs-click for command line documentation (#306) @athackst
• Fix launch files and update pylint settings (#305) @athackst
• Refactor test structure and rename files. (#304) @athackst
• Add mkdocs-simple-hooks to run gen_readme script in pre-build (#302) @athackst
• Cleanup requirements and setup.py dependencies (#301) @athackst

Dependency Updates

• Bump github/codeql-action from 1 to 2 (#307) @dependabot
• Bump mkdocs-material from 8.2.8 to 8.2.9 (#303) @dependabot

Release v1.1.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==1.1.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull althack/mkdocs-simple-plugin:v1.1.0

See it on dockerhub: https://hub.docker.com/repository/docker/althack/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v1.1.0

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🚀 New

• Drop support for EOL Python 3.6 (#275) @athackst
• Specify config file location in generator (#196) @athackst

🐛 Bug Fixes

• Update fontawesome icon name (#274) @athackst
• Fix issue with environment variables in deploy (#198) @athackst

🧰 Maintenance

• Update release drafter to collapse dependencies (#300) @athackst
• Fix gen_readme (#298) @athackst
• Update test to separate steps in github action (#251) @athackst
• Add google analytics (#248) @athackst
• Correct syntax in help text in generator (#199) @athackst
• Update htmlproofer to use my action (#195) @athackst
• Use action environment variables and reduce duplication. (#194) @athackst

Dependency Updates

81 changes

• Bump mkdocs-material from 8.2.5 to 8.2.6 (#291) @dependabot
• Bump pymdown-extensions from 9.2 to 9.3 (#290) @dependabot
• Bump docker/build-push-action from 2.9.0 to 2.10.0 (#289) @dependabot
• Bump release-drafter/release-drafter from 5.18.1 to 5.19.0 (#288) @dependabot
• Bump mkdocs-material from 8.2.4 to 8.2.5 (#287) @dependabot
• Bump mkdocs-material from 8.2.1 to 8.2.4 (#286) @dependabot
• Bump docker/login-action from 1.13.0 to 1.14.1 (#283) @dependabot
• Bump mkdocstrings from 0.18.0 to 0.18.1 (#285) @dependabot
• Bump actions/checkout from 2.4.0 to 3 (#284) @dependabot
• Bump actions/setup-python from 2.3.2 to 3 (#280) @dependabot
• Bump click from 8.0.3 to 8.0.4 (#279) @dependabot
• Bump pymdown-extensions from 9.1 to 9.2 (#273) @dependabot
• Bump mkdocs-material from 8.1.11 to 8.2.1 (#278) @dependabot
• Bump docker/login-action from 1.12.0 to 1.13.0 (#277) @dependabot
• Bump mkdocs-awesome-pages-plugin from 2.6.1 to 2.7.0 (#276) @dependabot
• Bump mkdocstrings from 0.17.0 to 0.18.0 (#270) @dependabot
• Bump mkdocs-material from 8.1.9 to 8.1.11 (#272) @dependabot
• Bump release-drafter/release-drafter from 5.17.6 to 5.18.1 (#269) @dependabot
• Bump mkdocs-macros-plugin from 0.6.3 to 0.6.4 (#266) @dependabot
• Bump actions/setup-python from 2.3.1 to 2.3.2 (#268) @dependabot
• Bump docker/build-push-action from 2.8.0 to 2.9.0 (#265) @dependabot
• Bump mkdocs-material from 8.1.8 to 8.1.9 (#264) @dependabot
• Bump mkdocs-material from 8.1.7 to 8.1.8 (#263) @dependabot
• Bump release-drafter/release-drafter from 5.17.5 to 5.17.6 (#262) @dependabot
• Bump docker/build-push-action from 2.7.0 to 2.8.0 (#261) @dependabot
• Bump mkdocs-material from 8.1.6 to 8.1.7 (#260) @dependabot
• Bump release-drafter/release-drafter from 5.16.1 to 5.17.5 (#259) @dependabot
• Bump release-drafter/release-drafter from 5.15.0 to 5.16.1 (#258) @dependabot
• Bump mkdocs-material from 8.1.4 to 8.1.6 (#257) @dependabot
• Bump mkdocs-material from 8.1.3 to 8.1.4 (#255) @dependabot
• Bump mkdocstrings from 0.16.2 to 0.17.0 (#254) @dependabot
• Bump mkdocs-material from 8.1.2 to 8.1.3 (#253) @dependabot
• Bump docker/login-action from 1.10.0 to 1.12.0 (#252) @dependabot
• Bump mkdocs-material from 8.1.1 to 8.1.2 (#250) @dependabot
• Bump mkdocs-material from 8.1.0 to 8.1.1 (#249) @dependabot
• Bump mkdocs-material from 8.0.5 to 8.1.0 (#247) @dependabot
• Bump mkdocs-material from 8.0.4 to 8.0.5 (#246) @dependabot
• Bump mkdocs-material from 8.0.3 to 8.0.4 (#245) @dependabot
• Bump mkdocs-material from 8.0.2 to 8.0.3 (#244) @dependabot
• Bump mkdocs-material from 8.0.1 to 8.0.2 (#243) @dependabot
• Bump mkdocs-material from 7.3.6 to 8.0.1 (#242) @dependabot
• Bump actions/setup-python from 2.3.0 to 2.3.1 (#241) @dependabot
• Bump mkdocs-macros-plugin from 0.6.0 to 0.6.3 (#239) @dependabot
• Bump mkdocs-awesome-pages-plugin from 2.6.0 to 2.6.1 (#240) @dependabot
• Bump actions/setup-python from 2.2.2 to 2.3.0 (#237) @dependabot
• Bump pymdown-extensions from 9.0 to 9.1 (#236) @dependabot
• Bump actions/checkout from 2.3.5 to 2.4.0 (#235) @dependabot
• Bump mkdocs-material from 7.3.5 to 7.3.6 (#234) @dependabot
• Bump mkdocs-material from 7.3.4 to 7.3.5 (#233) @dependabot
• Bump mkdocs-awesome-pages-plugin from 2.5.1 to 2.6.0 (#232) @dependabot
• Bump actions/checkout from 2.3.4 to 2.3.5 (#230) @dependabot
• Bump mkdocs-material from 7.3.3 to 7.3.4 (#231) @dependabot
• Bump mkdocs-awesome-pages-plugin from 2.5.0 to 2.5.1 (#229) @dependabot
• Bump mkdocs from 1.2.2 to 1.2.3 (#228) @dependabot
• Bump mkdocs-material from 7.3.2 to 7.3.3 (#227) @dependabot
• Bump click from 8.0.1 to 8.0.3 (#226) @dependabot
• Bump flake8 from 3.9.2 to 4.0.1 (#225) @dependabot
• Bump mkdocs-material from 7.3.1 to 7.3.2 (#224) @dependabot
• Bump mkdocs-material from 7.3.0 to 7.3.1 (#223) @dependabot
• Bump pymdown-extensions from 8.2 to 9.0 (#221) @dependabot
• Bump mkdocstrings from 0.16.1 to 0.16.2 (#222) @dependabot
• Bump mkdocstrings from 0.16.0 to 0.16.1 (#220) @dependabot
• Bump mkdocs-material from 7.2.6 to 7.3.0 (#219) @dependabot
• Bump mkdocstrings from 0.15.2 to 0.16.0 (#218) @dependabot
• Bump mkdocs-material from 7.2.5 to 7.2.6 (#216) @dependabot
• Bump docker/build-push-action from 2.6.1 to 2.7.0 (#213) @dependabot
• Bump mkdocs-macros-plugin from 0.5.12 to 0.6.0 (#214) @dependabot
• Bump mkdocs-material from 7.2.4 to 7.2.5 (#215) @dependabot
• Bump mkdocs-material from 7.2.3 to 7.2.4 (#212) @dependabot
• Bump mkdocs-material from 7.2.1 to 7.2.3 (#211) @dependabot
• Bump mkdocs-material from 7.2.0 to 7.2.1 (#209) @dependabot
• Bump mkdocs-material from 7.1.11 to 7.2.0 (#208) @dependabot
• Bump mkdocs from 1.2.1 to 1.2.2 (#207) @dependabot
• Bump mkdocs-material from 7.1.10 to 7.1.11 (#206) @dependabot
• Bump mkdocs-material from 7.1.9 to 7.1.10 (#205) @dependabot
• Bump docker/build-push-action from 2.6.0 to 2.6.1 (#204) @dependabot
• Bump docker/build-push-action from 2.5.0 to 2.6.0 (#203) @dependabot
• Bump mkdocs-material from 7.1.8 to 7.1.9 (#202) @dependabot
• Bump docker/login-action from 1.9.0 to 1.10.0 (#201) @dependabot
• Bump mkdocs-macros-plugin from 0.5.5 to 0.5.12 (#200) @dependabot
• Bump mkdocs-material from 7.1.7 to 7.1.8 (#197) @dependabot

Release v1.0.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==1.0.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull althack/mkdocs-simple-plugin:v1.0.0

See it on dockerhub: https://hub.docker.com/repository/docker/althack/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v1.0.0

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

⚡ Breaking

• Updating to support mkdocs 1.2 (#190) @athackst

🧰 Maintenance

• Remove livereload as a dependency now that mkdocstrings is updated (#193) @athackst
• Move docker images to althack (#189) @athackst

Dependency Updates

• Bump mkdocstrings from 0.15.1 to 0.15.2 (#192) @dependabot
• Bump mkdocs from 1.2 to 1.2.1 (#191) @dependabot

Release v0.9.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==0.9.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull athackst/mkdocs-simple-plugin:v0.9.0

See it on dockerhub: https://hub.docker.com/repository/docker/athackst/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v0.9.0

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🚀 New

• Add site_dir to github action (#184) @athackst

🐛 Bug Fixes

• fix bug in generator script + add unit tests (#182) @athackst

🧰 Maintenance

• Update dockerfile and requirements (#188) @athackst
• support venv in docker (#183) @athackst

Dependency Updates

• Update dockerfile and requirements (#188) @athackst

Release v0.8.1

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==0.8.1

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull athackst/mkdocs-simple-plugin:v0.8.1

See it on dockerhub: https://hub.docker.com/repository/docker/athackst/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v0.8.1

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🐛 Bug Fixes

• fix bug in config file setting in action (#181) @athackst

Dependency Updates

• Bump mkdocs-material from 7.1.5 to 7.1.6 (#180) @dependabot

Release v0.8.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==0.8.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull athackst/mkdocs-simple-plugin:v0.8.0

See it on dockerhub: https://hub.docker.com/repository/docker/athackst/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v0.8.0

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🚀 New

• Add additional config options to action (#177) @athackst

🧰 Maintenance

• update devcontainer (#179) @athackst
• Update links to website (#174) @athackst
• Simplify pypi release to just use github action + cleanup (#168) @athackst

📝 Documentation

• Fix readme grammar (#175) @athackst
• Update docker badge (#169) @athackst

Dependency Updates

• Bump docker/build-push-action from 2.4.0 to 2.5.0 (#176) @dependabot
• Bump click from 8.0.0 to 8.0.1 (#173) @dependabot
• Bump mkdocs-material from 7.1.4 to 7.1.5 (#172) @dependabot
• Bump pydocstyle from 6.0.0 to 6.1.1 (#171) @dependabot
• Bump mkdocstrings from 0.15.0 to 0.15.1 (#170) @dependabot

Release v0.7.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==0.7.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull athackst/mkdocs-simple-plugin:v0.7.0

See it on dockerhub: https://hub.docker.com/repository/docker/athackst/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v0.7.0

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🚀 New

• Capture all lines in scripts after start pattern until stop. (#153) @athackst

🧰 Maintenance

• fix docker release workflow (#151) @athackst
• update publish docs task (#150) @athackst

📝 Documentation

• Add information on how to run tests without ./tests/test.sh (#154) @athackst
• correct site names in examples to use folder name (#152) @athackst

Dependency Updates

• Bump TimonVS/pr-labeler-action from 3 to 3.1.0 (#167) @dependabot
• Bump docker/login-action from 1 to 1.9.0 (#166) @dependabot
• Bump actions/checkout from 2 to 2.3.4 (#165) @dependabot
• Bump docker/build-push-action from 2 to 2.4.0 (#164) @dependabot
• Bump click from 7.1.2 to 8.0.0 (#163) @dependabot
• Bump pymdown-extensions from 8.1.1 to 8.2 (#161) @dependabot
• Bump flake8 from 3.9.1 to 3.9.2 (#162) @dependabot
• Bump mkdocs-material from 7.1.3 to 7.1.4 (#160) @dependabot
• Bump mkdocs-material from 7.1.2 to 7.1.3 (#159) @dependabot
• Bump mkdocs-material from 7.1.1 to 7.1.2 (#158) @dependabot
• Bump flake8 from 3.9.0 to 3.9.1 (#157) @dependabot
• Bump actions/setup-python from v2.2.1 to v2.2.2 (#156) @dependabot
• Bump mkdocs-material from 7.1.0 to 7.1.1 (#155) @dependabot

Release v0.6.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==0.6.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull athackst/mkdocs-simple-plugin:v0.6.0

See it on dockerhub: https://hub.docker.com/repository/docker/athackst/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v0.6.0

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🚀 New

• use full path glob matching for ignore folders (#144) @athackst

🐛 Bug Fixes

• return replace to original implementation by fixing drop lines (#141) @athackst
• fix: Make extraction w/ no start pattern active from beginning (#138) @gwhitney

🧰 Maintenance

• add build script (#148) @athackst
• Add example readme generator. (#145) @athackst
• Update grep results to grab all lines (#143) @athackst
• fixed vscode clean task (#142) @athackst
• Update release workflow to use VERSION file (#135) @athackst

📝 Documentation

• use more snippets in docs (#146) @athackst
• update readme (#140) @athackst

Dependency Updates

• Bump mkdocs-material from 7.0.6 to 7.1.0 (#149) @dependabot

Release v0.5.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==0.5.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull athackst/mkdocs-simple-plugin:v0.5.0

See it on dockerhub: https://hub.docker.com/repository/docker/athackst/mkdocs-simple-plugin

Github

- name: Build docs
  uses: athackst/mkdocs-simple-plugin:v0.5.0

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

🚀 New

• Add snippet extraction from source files (#122) @athackst

🧰 Maintenance

• cleanup workflows and update release-drafter template (#134) @athackst
• Maint/fix typo (#133) @athackst
• update setup.py at each release draft (#132) @athackst
• update release drafter settings (#131) @athackst
• fix path generation to only save watch paths (#125) @athackst
• Refactor semilterate to a class (#121) @athackst
• Bugfix/fix testing (#120) @athackst

📝 Documentation

• Seperate extraction into a module, update doc comments (#128) @athackst
• Update examples for website (#124) @athackst

Dependency Updates

• Bump pydocstyle from 5.1.1 to 6.0.0 (#130) @dependabot
• Bump release-drafter/release-drafter from v5.14.0 to v5.15.0 (#129) @dependabot
• Bump mkdocs-material from 7.0.5 to 7.0.6 (#127) @dependabot
• Bump flake8 from 3.8.4 to 3.9.0 (#126) @dependabot
• Bump mkdocs-macros-plugin from 0.5.0 to 0.5.5 (#118) @dependabot
• Bump mkdocs-material from 7.0.3 to 7.0.4 (#119) @dependabot
• Bump mkdocs-material from 7.0.2 to 7.0.3 (#117) @dependabot
• Bump mkdocs-material from 7.0.0 to 7.0.2 (#115) @dependabot
• Bump mkdocs-material from 6.2.8 to 7.0.0 (#113) @dependabot
• Bump release-drafter/release-drafter from v5.13.0 to v5.14.0 (#111) @dependabot

Release v0.4.0

Get it

Python

Install it with pip

pip install mkdocs-simple-plugin==0.4.0

See it on pypi: https://pypi.org/project/mkdocs-simple-plugin

Docker

Pull it with docker

docker pull athackst/mkdocs-simple-plugin:latest

See it on dockerhub: https://hub.docker.com/repository/docker/athackst/mkdocs-simple-plugin

Github

See it in the actions marketplace: https://github.com/marketplace/actions/mkdocs-simple-action

What’s Changed

This version adds the semiliterate extension, which lets you extract documentation from your source files with fenced blocks.

Changelist

• Update docker readme + small formatting fixes (#107) @athackst
• switch to .pages (#106) @athackst
• update default regex and dockerfiles (#105) @athackst
• Bump mkdocs-material from 6.2.6 to 6.2.8 (#104) @dependabot
• Bump pymdown-extensions from 8.1 to 8.1.1 (#101) @dependabot
• Bump mkdocs-material from 6.2.5 to 6.2.6 (#102) @dependabot
• Bump mkdocs-material from 6.2.4 to 6.2.5 (#100) @dependabot
• format comments to pass pydocstyle linter (#99) @athackst
• remove building by default in mkdocs_simple_gen (#98) @athackst
• feat: Allow semiliterate patterns with multiple "modes" of extraction (#97) @gwhitney
• add vscode debugger settings (#95) @athackst
• fix: Allow a semiliterate destination without a matching group in pattern (#94) @gwhitney
• Bump mkdocs-material from 6.2.3 to 6.2.4 (#92) @dependabot
• use semiliterate to generate documentation (#91) @athackst
• update autopep8 to be aggressive, ran formatter (#90) @athackst
• Add test for mkdocstrings inside extracted documentation from code (#89) @athackst
• feat: Extract documentation from source files (#85) @gwhitney
• added ability to read site_dir from config file (#87) @athackst
• Add options to guard deploy testing. (#86) @athackst
• Bump release-drafter/release-drafter from v5.12.1 to v5.13.0 (#83) @dependabot
• Bump mkdocs-material from 6.2.2 to 6.2.3 (#84) @dependabot
• Bump pymdown-extensions from 8.0.1 to 8.1 (#80) @dependabot
• Feature/continuous release (#82) @athackst
• Feature/update release workflow (#81) @athackst
• Bump mkdocs-material from 6.1.7 to 6.2.2 (#79) @dependabot
• Create codeql-analysis.yml (#78) @athackst