-
Notifications
You must be signed in to change notification settings - Fork 128
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
doc: remove legacy template file #604
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed most (all?) of the sphinx warnings while I was at it...
reparametrized accordingly using `lon_normalize`. Note that this option has no effect when | ||
using the "geosphere" method because it is independent from the parametrization. | ||
Default: True | ||
a suitable interval is determined using :py:func:`lon_bounds` and the longitudinal values |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is unrelated to the main issue in this PR. I was curious to test cross-references in docstrings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
... which doesn't make anything, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Of course it does! Sorry. (I looked at the wrong tab 🙄)
large distances and high latitudes. | ||
* "geosphere": Exact spherical distance. Much more accurate at all distances, but slow. | ||
|
||
* "equirect": Distance according to sinusoidal projection. Fast, but inaccurate for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is unrelated to the main issue in this PR. Correcting indentation and adding empty lines before and after bullet lists fixes a few sphinx warnings.
climada\.util\.cached module | ||
---------------------------- | ||
|
||
.. automodule:: climada.util.cached | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This submodule doesn't exist, hence we can remove the reference from the docs.
@@ -179,7 +179,7 @@ | |||
"source": [ | |||
"### Gitflow works on the `develop` branch instead of `main`\n", | |||
"\n", | |||
"\n", | |||
"\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This fixes an error/warning output of sphinx.
looks good to me. 😃 |
Excellent, @tovogt! I was wondering about this stray title 😅 Also, nice work with the crossrefs. Most of the docstrings don't use them yet. That might be a job for a student assistant 🤔 |
Changes proposed in this PR:
PR Author Checklist
develop
)PR Reviewer Checklist