reMarkAble/NOTES.md at master · aa9863/reMarkAble

Setup

If not already

python -m venv env

python setup.py develop

pip install pytest
pytest

Or to stop and capture outputs

pytest -x -s

Or Nicer HTML output

pytest --html=report.html

Or via setup tools

python setup.py test

Using Pylint Because

pylint remarkable

Note on Excluded Messages

I dont agree with snake_case for function names. drinkingCamelCase
W1202 Meh, I can see arguments for doing this for speed in n logs, but prefer consistency

And as a much nicer HTML

$ pylint remarkable -f json | pylint-json2html > pylint.html

There is a command line interface through the runDMC command

runDMC <input> [-t template] [-d dir for local templates] [-o output file]

If no output file is specified, we generate .html

Can be found in the examples directory

We have an example of a coursework Brief Using the built in template

Render with

$examples runDMC CourseworkBrief.md -t CourseworkBrief.jinja2

Paths / Organisation for the Templates do it

The second is better for orgnaisation, but a makes the command line clunky. We could map in the main function though...

Can be found

Generated with MKDocs

To regenerate the docs

#Install
$pip install mkdocs

#Build (in the docs directory)
docs$ mkdocs build

#Preview 
docs$ mkdocs serve

upload mkdocs gh-deploy

theme mkdocs-material

And a really useful set of extenstions