mktestdocs 0.2.0__tar.gz → 0.2.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/PKG-INFO +1 -7
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/README.md +6 -4
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/mktestdocs/__init__.py +1 -1
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/mktestdocs.egg-info/PKG-INFO +1 -7
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/mktestdocs.egg-info/SOURCES.txt +0 -2
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/mktestdocs.egg-info/top_level.txt +0 -1
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/setup.py +1 -1
- mktestdocs-0.2.0/tests/__init__.py +0 -0
- mktestdocs-0.2.0/tests/conftest.py +0 -12
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/LICENSE +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/mktestdocs/__main__.py +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/mktestdocs.egg-info/dependency_links.txt +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/mktestdocs.egg-info/requires.txt +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/setup.cfg +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/tests/test_actual_docstrings.py +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/tests/test_class.py +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/tests/test_codeblock.py +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/tests/test_markdown.py +0 -0
- {mktestdocs-0.2.0 → mktestdocs-0.2.1}/tests/test_mktestdocs.py +0 -0
@@ -12,10 +12,12 @@ pip install mktestdocs
|
|
12
12
|
|
13
13
|
## Usage
|
14
14
|
|
15
|
-
Let's say that you're using [mkdocs](https://squidfunk.github.io/mkdocs-material/getting-started/)
|
16
|
-
writing down markdown to explain how your
|
17
|
-
|
18
|
-
|
15
|
+
Let's say that you're using [mkdocs](https://squidfunk.github.io/mkdocs-material/getting-started/)
|
16
|
+
for your documentation. Then you're writing down markdown to explain how your Python packages work.
|
17
|
+
It'd be a shame if a codeblock had an error in it, so it'd be
|
18
|
+
great if you could run your unit tests against them.
|
19
|
+
|
20
|
+
This package allows you to do _just that_. Here's an example:
|
19
21
|
|
20
22
|
```python
|
21
23
|
import pathlib
|
@@ -8,8 +8,6 @@ mktestdocs.egg-info/SOURCES.txt
|
|
8
8
|
mktestdocs.egg-info/dependency_links.txt
|
9
9
|
mktestdocs.egg-info/requires.txt
|
10
10
|
mktestdocs.egg-info/top_level.txt
|
11
|
-
tests/__init__.py
|
12
|
-
tests/conftest.py
|
13
11
|
tests/test_actual_docstrings.py
|
14
12
|
tests/test_class.py
|
15
13
|
tests/test_codeblock.py
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|