divio-docs-parser 0.1.2

Collect and parse all your divio-style documentation with just one line of code!

Divio Docs Parser

Collect and parse all your divio-style documentation with just one line of code! This script will scan any files/directories/strings you pass. For example:

• If you have a how-to section in your README, that'll get extracted and put in the right spot
• Or, if you have an how-to.md file, it'll get added in its entirety!

How-To

Install from pip

python3 -m pip install divio_docs_parser

Clone & run scripts locally

git clone https://github.com/Denperidge-Redpencil/divio-docs-parser.git
cd divio-docs-gen/
python3 -m src.divio_docs_parser

Run tests

git clone https://github.com/Denperidge-Redpencil/divio-docs-parser.git
cd divio-docs-gen/
python3 -m unittest

Build & install package locally

git clone https://github.com/Denperidge-Redpencil/divio-docs-parser.git
cd divio-docs-gen/
python3 -m pip install --upgrade build setuptools  # If no setuptools dist can be found, try using a higher python version
python3 -m build && python3 -m pip install --force-reinstall ./dist/*.whl

Note: other Python versions can be used!

Explanation

The Divio structure is built upon splitting your documentation into 4 types of documentations. . In this repository they're referred to as sections.

If you want to know more about the design principles of this project, feel free to check out my writeup here!

Reference

Synonyms

For ease of use and freedom of implementation, every section has synonyms.

Section	Synonyms
Tutorials	Getting started
How-to Guides	How-To, Guide, Usage
Explanation	Discussion, background material
Reference	Technical