From ab5a1e2a693094792579a03a2e9e53c17ed4d295 Mon Sep 17 00:00:00 2001 From: Nicola Soranzo Date: Mon, 27 Mar 2023 16:01:20 +0100 Subject: [PATCH] Document documentation --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e876012fa8d..e657fb85218 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -168,6 +168,20 @@ https://help.github.com/en/github/getting-started-with-github/git-and-github-lea [reStructured Text (RST)](https://docutils.sourceforge.io/rst.html) format and compatible with [Sphinx](https://www.sphinx-doc.org). +## Documentation + +General documentation (e.g. admin, development, release notes) is found in the +``doc/source/`` directory. +The documentation source files need to be written in one of these markup +languages: +- [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) + (with Sphinx extensions) +- [Markdown](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html) + (with MyST-Parser extensions). +These source files are then built into HTML documentation with +[Sphinx](https://www.sphinx-doc.org/) by running ``make docs`` and published on +the [Galaxy Documentation website](https://docs.galaxyproject.org/). + ## A Quick Note about Tools For the most part, Galaxy tools should be published to a [Tool