Getting started

This section covers four topics:

• How to set up and use the WISE environment, so that you can use Sphinx to generate documentation pages similar to this one.

• How to build and view the documentation in your own computer, using Sphinx.

• Which software to use when writing the documentation itself, using either Markdown or reStructuredText (reST).

• How to publish the documentation online, using GitHub Pages and GitHub Actions to build it automatically when the git repository is updated.

It also works as a quick reference in case you don’t remember a step in the process.

Warning

If you are an end user (a.k.a. a “thematic”) this is not the page you’re looking for :-)

This documentation is intended for developers and contributors who are responsible for creating and maintaining the documentation for WISE dataflows and projects.

This documentation is partial, incomplete and a work-in-progress… Contributions are welcome.