Metadata-Version: 2.1
Name: docutools
Version: 2021.5.12
Summary: Documentation Tools for the Devapp Framework
Home-page: http://github.pages.com/docutools/
License: BSD 2-Clause Simplified License
Author: Gunther Klessinger
Author-email: gunther.klessinger@axiros.com
Requires-Python: >=3.6,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: anybadge (>=1.7.0,<2.0.0)
Requires-Dist: devapps (>=2021.5.10,<2022.0.0)
Project-URL: Repository, https://axiros.github.com/devapps/docutools
Description-Content-Type: text/markdown

#  docutools

<p attr="autogenerated by make_badges"></p>

[![docs][img_docs]][lnk_docs]&nbsp; [![package][img_package]][lnk_package]&nbsp; [![discuss][img_discuss]][lnk_discuss]&nbsp; [![pipeline][img_pipeline]][lnk_pipeline]&nbsp; [![coverage][img_coverage]][lnk_coverage]&nbsp; [![statements][img_statements]][lnk_statements]&nbsp; [![code style][img_code style]][lnk_code style]

[lnk_docs]: http://github.pages.com/docutools/
[img_docs]: https://badges.github.com/scm/hg/noauth/badges/raw-file/62eef82452cb/docutools/documentation.svg
[lnk_package]: https://artifacts.github.com/artifactory/pypi-ax-sources/docutools/2021.1.21.dev14+g13aab44.d20210418/docutools-2021.1.21.dev14+g13aab44.d20210418.tar.gz
[img_package]: https://badges.github.com/scm/hg/noauth/badges/raw-file/62eef82452cb/docutools/pypi_package.svg
[lnk_discuss]: https://join.skype.com/krSNYZqvEmJm
[img_discuss]: https://badges.github.com/scm/hg/noauth/badges/raw-file/62eef82452cb/docutools/discuss.svg
[lnk_pipeline]: https://axiros.github.com/devapps/docutools/-/commits/master
[img_pipeline]: https://badges.github.com/scm/hg/noauth/badges/raw-file/62eef82452cb/docutools/pipeline.svg
[lnk_coverage]: http://github.pages.com/docutools//coverage/index.html
[img_coverage]: https://badges.github.com/scm/hg/noauth/badges/raw-file/62eef82452cb/docutools/coverage.svg
[lnk_statements]: http://github.pages.com/docutools//coverage/index.html
[img_statements]: https://badges.github.com/scm/hg/noauth/badges/raw-file/62eef82452cb/docutools/statements.svg
[lnk_code style]: https://github.com/axiros/axblack
[img_code style]: https://badges.github.com/scm/hg/noauth/badges/raw-file/62eef82452cb/docutools/code_style_ax_black.svg

<p attr="autogenerated by make_badges"></p>


## Documentation building tools

![](img/page-teaser.png){: style="width:1550px" }

## Requirements

docutools requires Python 3.6 or above.

<details>
<summary>To install Python 3.6, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>

```bash
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.6
pyenv install 3.6.12

# make it available globally
pyenv global system 3.6.12
```
</details>

## Installation

With `pip`:
```bash
python3.6 -m pip install docutools
```

With [`pipx`](https://github.com/pipxproject/pipx):
```bash
python3.6 -m pip install --user pipx

pipx install --python python3.6 docutools
```

----
Last modified: Fri Dec 18 13:32:05 2020
<!-- pre_proc_marker -->


----


Last modified: Sun Apr 18 22:48:03 2021



