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

!EX! Relocate Technical Papers, with some changes to structure #5604

Closed
wants to merge 5 commits into from

Conversation

ESadek-MO
Copy link
Contributor

@ESadek-MO ESadek-MO commented Nov 24, 2023

🚀 Pull Request

An extension to #5602. This juggles structure around a bit more, takes it a bit further.


Consult Iris pull request check list

@ESadek-MO ESadek-MO changed the title Relocate Technical Papers, with some changes to structure !EX! Relocate Technical Papers, with some changes to structure Nov 24, 2023
Copy link

codecov bot commented Nov 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (507c34c) 89.68% compared to head (93f4557) 89.68%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5604   +/-   ##
=======================================
  Coverage   89.68%   89.68%           
=======================================
  Files          90       90           
  Lines       22815    22815           
  Branches     5445     5445           
=======================================
  Hits        20462    20462           
  Misses       1619     1619           
  Partials      734      734           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ESadek-MO
Copy link
Contributor Author

ESadek-MO commented Nov 24, 2023

I've noticed this adds another link to the navigation bar, which @tkknight explicitly tried to avoid with #5505.

Copy link
Member

@pp-mo pp-mo left a comment

Choose a reason for hiding this comment

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

I quite like this, but the issue with the extra top-bar item is a nuisance.
Maybe can fix as I suggested ??

Since this includes all of #5602 commits, I should think you can close that + declare this "good to go" instead. Unless you have other reservations + prefer the original.

@@ -329,6 +329,6 @@ Documentation
* A clarification of the behaviour of
:func:`iris.analysis.calculus.differentiate`.

* A new :doc:`"Technical Papers" </techpapers/index>` section has been added to
* A new Technical Papers section has been added to
Copy link
Member

Choose a reason for hiding this comment

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

This could now be pointed a the new combined "further topics" page ?
I thought that was part of the reason for the new page !

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the 1.7 what's new; whereas all I had done was move where the Tech Papers section was, now I've removed it altogether. To change the path to further topics seems non-representative.

The file I've linked to because the file hasn't changed.

@@ -203,4 +203,12 @@ The legacy support resources:
Iris API <generated/api/iris>


.. toctree::
Copy link
Member

Choose a reason for hiding this comment

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

I guess it is this which adds the unwanted extra top section.
Since this part appears at the end of the User Guide overview page, do we actually need this here ??

Disclaimer : I don't really understand this stuff.
( But at least I know it )

Copy link
Contributor Author

@ESadek-MO ESadek-MO Nov 24, 2023

Choose a reason for hiding this comment

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

It no longer does appear at the end of the User Guide overview, see the docs built from this PR.

By making it it's own section, I've removed it from the user guide toctree. This also removes it in the overview. Currently the only way to access this is through the navbar.

@ESadek-MO
Copy link
Contributor Author

This was decided to be too far, so reverting to #5602

@ESadek-MO ESadek-MO closed this Nov 30, 2023
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.

2 participants