MetOffice / MetOffice/CMEW

Include license in documentation

Open
#220 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
5
Forks
3
Avg merge
5d 6h
Merged PRs (30d)
8

Description

**Is your feature request related to a problem? Please describe.**
The license included in the `LICENSE.md` file should automatically be pulled into the documentation.

**Describe the solution you'd like**
The [Sphinx documentation](https://www.sphinx-doc.org/en/master/usage/markdown.html) recommends using the [MyST-Parser](https://myst-parser.readthedocs.io/en/latest/) extension to include markdown files in rST.

**Describe alternatives you've considered**
At a minimum, the license file should be linked from the documentation. I have also tried simply using the directive `.. include:: ../../LICENSE.md`, but this doesn't render the license well and raises warnings when building the documentation.

**Additional context**
MyST-Parser is not currently included in the ESMValTool community environment at the Met Office, it will need to be installed in order for the above method to work.

Contributor guide

Open the contributing guide

Research direction

Start with LICENSE.md and the existing Sphinx documentation setup. Check how MyST-Parser could include the license or whether a documentation link is more appropriate, then build the documentation to verify the license is rendered or linked without warnings and that the required extension is available in the community environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.