New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document w/ documentary #478

Open

zavr-1 wants to merge 4 commits into Leonidas-from-XIV:master from docume:master

zavr-1 commented Sep 5, 2018

The advantages are:

Table of contents for faster navigation and better structure perception.
Embedding examples and executing them to print the output. Removes inconsistencies between the documentation and what is the actual output. Saves time between copying and pasting.
Structure by files for easier maintenance.
More quality control as the examples will be forked when compiled, meaning output will change if the output is incorrect.

zavr-1 added 4 commits

September 5, 2018 18:07


          install documentary

487fe6a


          doc script

8d7955b


          create documentary folder

0365a9d


          compile documentary

7867faa

coveralls commented Sep 5, 2018

Coverage remained the same at 97.633% when pulling 7867faa on docume:master into 0f0a298 on Leonidas-from-XIV:master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet