| target: | https://travis-ci.org/johnpneumann/MarkdownClerk |
|---|
| target: | https://coveralls.io/github/johnpneumann/MarkdownClerk?branch=master |
|---|
| target: | http://markdownclerk.readthedocs.io/en/latest/?badge=latest |
|---|---|
| alt: | Documentation Status |
Markdown Clerk is a simple project tracker that generates markdown files in a structured way.
Table of Contents
Installation can be done with pip.
pip install MarkdownClerkIf you want to build it from source, you can pip install it by cloning the repository and running:
git clone https://github.com/johnpneumann/MarkdownClerk.git
cd MarkdownClerk
pip install .Documentation can be found at [readthedocs](http://markdownclerk.readthedocs.io/en/latest/)
Adherence to code quality and current form is strictly enforced, however,
contributions are greatly appreciated. To get started, there is a
dev.txt file within requirements that will install everything for
testing, documentation generation and some extra bits used for daily
work, such as iPython.
To run the unit tests, install tox and then run tox.
To clean up the build, run make clean
To generate documentation, you'll need to install Sphinx and sphinx_rtd_theme_, which can be installed using the following command:
pip install -r requirements/docs.txt
Once those are installed, you'll want to generate the api documentation. Run the following from the top level of this repo (where this file is):
sphinx-apidoc -f -o docs/api markdownclerk
Once that's done documentation can be generated by entering the docs
directory and running make html. The output will be generated into
the _build/html directory.
A Makefile is provided at the top level of this repo that does various
bits for you without you needing to do much if anything. To see the commands
available run make or make help and it will output what commands are
available. Sample output from make help follows:
clean - runs clean-build, clean-pyc, clean-tests and clean-log clean-build - remove build artifacts clean-pyc - remove Python file artifacts clean-tests - remove test files clean-log - remove log files lint - check style with flake8 checkmanifest - ensure the MANIFEST.in file is up to date test - run tests quickly with the default Python test-all - run tests on every Python version with tox coverage - check code coverage quickly with the default Python docs - generate Sphinx HTML documentation, including API docs release - package and upload a release sdist - package
If you wish to build the docs, run tests or check the manifest, the requirements above still stand.
This package was created with Cookiecutter and the johnpneumann/cookiecutter-py project template version 1.0.1.