Github wiki is a great solution for creating well struct and easy to browse documentations. More of that it is placed near your code, issues and. This python script allows to create nice looking PDF files from a github wiki, which can be used as offline/printable documentation. The wiki markdown files are converted via pandoc to html and are joined to one large html file, which is then converted to PDF using wkhtmltopdf. You need to clone the wiki repo and edit it on your system. Add files to the files directory (or subdirectory below it). For example: files/medical-site.info`.
|Language:||English, Spanish, French|
|Distribution:||Free* [*Register to download]|
Each wiki is a Git repository, so you're able to push and pull them like anything . It's a Python 3 script made just to convert a GitHub Wiki to pdf form, using the. Generate HTML & PDF documentation from Github wiki or any other markdown- based wiki. Simply view any Markdown file on GitHub, then in your URL bar replace the medical-site.info part of the URL with medical-site.info — your markdown file will be rendered.
The doc annotation Most of the annotations can contain a doc annotation, that can contain the main part of the documentation.
The usage contains mainly a description and and set of examples, examples: a set of examples that are not related to a particular usage, see: other related keywords. It is also used to generate unit test and patterns. The type of the variable is determined thanks to the return type of the operator with these parameters. This example can also generate a unit test model.
In this case, the value in the variable will be compared to the equals part. How to document operators A GAML operator is defined by a Java method annoted by the operator annotation see the list of all annotations for more details about annotations.
In the core of GAMA, most of the operators are defined in the plugin msi. The documentation generator will use information from: the operator annotation: value: it provides the name s of the operator if an operator has several names, the other names will be considered as alternative names category: it is used to classified the operators in categories the doc annotation, the method definition: the return value type parameters and their type if the method is static, the IScope attribute is not taken into account How to document statements A GAML statement is defined by a Java class annoted by the symbol annotation see the list of all annotations for more details about annotations.
In the core of GAMA, most of the statements are defined in the plugin msi. The documentation generator will use information from: symbol annotation, facets annotation each facet can contain a documentation in a doc annotation , inside annotation where the statement can be used , doc annotation How to document skills A GAML skill is defined by a Java class annoted by the skill annotation see the list of all annotations for more details about annotations. If your submission doesn't show up on the subreddit, send us a message and we'll take it out of the spam filter for you!
You can get GitHub wikis as html or markdown pretty easily. Both of these are readable offline.
But if you want to convert them to a pdf, there are a multitude of tools that will do it, including pandoc, wkhtmltopdf, and various "print to pdf" drivers. You can clone it to your machine.
All rights reserved. Want to join?
Log in or sign up in seconds. Submit a new link.