Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure documentation #1587

Merged
merged 3 commits into from Mar 19, 2020
Merged

Restructure documentation #1587

merged 3 commits into from Mar 19, 2020

Conversation

bouweandela
Copy link
Member

@bouweandela bouweandela commented Mar 17, 2020

Implement documentation structure proposed in #1574

Related to ESMValGroup/ESMValCore#575

The new structure can be previewed at https://esmvaltool.readthedocs.io/en/doc/


Tasks

  • Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom)
  • Give this pull request a descriptive title that can be used as a one line summary in a changelog
  • Circle/CI tests pass. Status can be seen below your pull request. If the tests are failing, click the link to find out why.
  • Preferably Codacy code quality checks pass, however a few remaining hard to solve Codacy issues are still acceptable. Status can be seen below your pull request. If there is an error, click the link to find out why. If you suspect Codacy may be wrong, please ask by commenting.

@bouweandela bouweandela marked this pull request as ready for review Mar 17, 2020
doc/sphinx/source/gensidebar.py Outdated Show resolved Hide resolved
- Deutsches Zentrum für Luft- und Raumfahrt (DLR), Institut für Physik
der Atmosphäre, Germany (PI)

ESMValTool Core PI and Developer: contact for requests to use the
Copy link
Member

@nielsdrost nielsdrost Mar 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not understand this sentence. This perhaps needs re-doing after the new goverance. This section also does not contain any contact info ;-)

Copy link
Member Author

@bouweandela bouweandela Mar 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'll make an issue. I tried not to work too much on the content in this pull request, I mostly shuffled existing content around.

doc/sphinx/source/gensidebar.py Outdated Show resolved Hide resolved
Copy link
Member

@nielsdrost nielsdrost left a comment

Looks great, huge improvement!

Comments all minor.

doc/sphinx/source/introduction.rst Outdated Show resolved Hide resolved
doc/sphinx/source/introduction.rst Outdated Show resolved Hide resolved
doc/sphinx/source/introduction.rst Outdated Show resolved Hide resolved
doc/sphinx/source/introduction.rst Outdated Show resolved Hide resolved
doc/sphinx/source/introduction.rst Outdated Show resolved Hide resolved
doc/sphinx/source/introduction.rst Outdated Show resolved Hide resolved
@bouweandela bouweandela merged commit d5df184 into master Mar 19, 2020
4 checks passed
@bouweandela bouweandela deleted the doc branch Mar 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants