Welcome to the RSE Documententation Page!¶
Here you can find resources based on the RSE summer school workshop on Documentation.
Slide deck¶
Here is a copy of the slides used during the workshop:
You can also find summary documents about
Documentation templates¶
Tutorial-driven development¶
A method to develop new features with documentation as the driving force.
Documentation generators¶
Turn plain text and code into discoverable, understandable, and clean output
-
plugins for Python, Javascript, Doxygen, etc see list
compatible with Read the Docs
-
Python, C++, C, Javascript
compatible with Read the Docs
-
C++, C, Python, PHP, Java, C#, Objective-C, Fortran, VHDL, Splice, IDL, and Lex
-
R
-
R, Python, Julia, C++, and SQL
-
R, Python, Julia, Observable (JS
-
Fortran
-
Julia
-
Documeantion for OpenAPI or AsyncAPI specification
Sample Sphinx project¶
Go to this page to see some examples of various things you can do with Sphinx
A list of Sphinx extensions we have found useful:
Sample RMarkdown page using GitHub Pages¶
Here is an example of using RMarkdown with GitHub pages.
Documentation hosting platforms¶
Free for open source projects.
More interesting and useful documentation resources¶
-
a global community of people who care about documentation. Numerous articles and videos, a newsletter, conferences, and a Slack channel with over 20,000 members!
A curated list of awesome documentation tools, guides, and good practice
pandoc - a universal document converter
Tables generator - Generate tables in LaTeX, Markdown, HTML, MediaWiki, or text from a GUI
nbgitpuller - Generate links to launch notebooks in a selected service (like JupyterHub and Binder)
lychee - Link checker for your docs