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

doc: remove legacy template file #604

Merged
merged 2 commits into from
Dec 13, 2022

Conversation

tovogt
Copy link
Collaborator

@tovogt tovogt commented Dec 12, 2022

Changes proposed in this PR:

image

PR Author Checklist

PR Reviewer Checklist

@tovogt tovogt requested a review from peanutfun December 12, 2022 16:12
Copy link
Collaborator Author

@tovogt tovogt left a 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
Copy link
Collaborator Author

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.

Copy link
Collaborator

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Before:
image
After:
image

Copy link
Collaborator

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
Copy link
Collaborator Author

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.

Comment on lines -12 to -19
climada\.util\.cached module
----------------------------

.. automodule:: climada.util.cached
:members:
:undoc-members:
:show-inheritance:

Copy link
Collaborator Author

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",
"![](flow_1.png)\n",
"![](img/flow_1.png)\n",
Copy link
Collaborator Author

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.

@emanuel-schmid
Copy link
Collaborator

looks good to me. 😃

@emanuel-schmid emanuel-schmid merged commit 973f513 into develop Dec 13, 2022
@emanuel-schmid emanuel-schmid deleted the feature/docs_without_ugly_header branch December 13, 2022 13:56
@peanutfun
Copy link
Member

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 🤔

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.

3 participants