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

Add documentation skeleton #268

Merged
merged 7 commits into from
May 22, 2023

Conversation

stephenworsley
Copy link
Contributor

Addresses #264

@codecov
Copy link

codecov bot commented May 17, 2023

Codecov Report

Merging #268 (f5a89b4) into main (bad51a3) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #268   +/-   ##
=======================================
  Coverage   98.79%   98.79%           
=======================================
  Files          33       33           
  Lines        3563     3563           
=======================================
  Hits         3520     3520           
  Misses         43       43           
Impacted Files Coverage Δ
esmf_regrid/__init__.py 44.44% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@trexfeathers
Copy link
Contributor

trexfeathers commented May 18, 2023

✔ Might be worth committing a docs/src/_static directory, since it's referenced in conf.py and that has been causing a warning during docs building for the last year. Either that or you could remove the entry in conf.py.

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

✔ The title of the documentation includes 0.6.0, which is misleading when viewing bleeding-edge documentation. For the last two releases we've forgotten to set __version__ to be a dev version immediately after the release, like we did in #157.

docs/src/installing.rst Show resolved Hide resolved
docs/src/userguide/scheme_comparison.rst Outdated Show resolved Hide resolved
docs/src/userguide/scheme_comparison.rst Outdated Show resolved Hide resolved
docs/src/index.rst Outdated Show resolved Hide resolved
@trexfeathers trexfeathers linked an issue May 18, 2023 that may be closed by this pull request
Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

Here are the rest of my comments 🙂

docs/src/userguide/examples.rst Outdated Show resolved Hide resolved
docs/src/userguide/scheme_comparison.rst Outdated Show resolved Hide resolved
docs/src/userguide/scheme_comparison.rst Outdated Show resolved Hide resolved
docs/src/userguide/scheme_comparison.rst Outdated Show resolved Hide resolved
docs/src/index.rst Show resolved Hide resolved
docs/src/index.rst Show resolved Hide resolved
docs/src/index.rst Show resolved Hide resolved
stephenworsley and others added 2 commits May 18, 2023 15:03
Co-authored-by: Martin Yeo <40734014+trexfeathers@users.noreply.github.com>
@stephenworsley stephenworsley marked this pull request as ready for review May 22, 2023 11:26
@trexfeathers trexfeathers merged commit 780fd62 into SciTools-incubator:main May 22, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add skeleton of user guide
2 participants