Skip to content
This repository has been archived by the owner on Mar 1, 2023. It is now read-only.

Make docs strict #1244

Merged
merged 1 commit into from
Jun 14, 2020
Merged

Make docs strict #1244

merged 1 commit into from
Jun 14, 2020

Conversation

charleskawczynski
Copy link
Member

@charleskawczynski charleskawczynski commented Jun 14, 2020

Description

  • Fixes / adds docs.
  • Make docs strict.
  • Update's landing page README badge for unit tests

Closes #1189. Supercedes #1181.

I have

  • Written and run all necessary tests with CLIMA by including tests/runtests.jl
  • Followed all necessary style guidelines and run julia .dev/climaformat.jl .
  • Updated the documentation to reflect changes from this PR.

For review by CLIMA developers

  • There are no open pull requests for this already
  • CLIMA developers with relevant expertise have been assigned to review this submission
  • The code conforms to the style guidelines and has consistent naming conventions. julia .dev/format.jl has been run in a separate commit.
  • This code does what it is technically intended to do (all numerics make sense physically and/or computationally)

@charleskawczynski charleskawczynski marked this pull request as ready for review June 14, 2020 06:51
@charleskawczynski charleskawczynski force-pushed the ck/docs_fixes_round_5 branch 4 times, most recently from 7a44989 to 7a03f99 Compare June 14, 2020 18:00
@@ -918,7 +918,7 @@ end

Given points `(a, b, c)` on the surface of a cube, warp the points out to a
spherical shell of radius `R` based on the equiangular gnomonic grid proposed by
Ronchi, Iacono, Paolucci (1996) <https://doi.org/10.1006/jcph.1996.0047>
Ronchi, Iacono, Paolucci (1996) https://linkinghub.elsevier.com/retrieve/pii/S0021999196900479
Copy link
Member Author

Choose a reason for hiding this comment

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

We should figure out why Documenter is warning on redirected DOI links

@charleskawczynski
Copy link
Member Author

bors r+

@bors
Copy link
Contributor

bors bot commented Jun 14, 2020

@bors bors bot merged commit b17f43e into master Jun 14, 2020
@bors bors bot deleted the ck/docs_fixes_round_5 branch June 14, 2020 20:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable strict = true in makedocs
1 participant