Skip to content

Conversation

@ahms5
Copy link
Member

@ahms5 ahms5 commented Apr 23, 2025

Problem:
header in our documantion becomes to long and it not uniform along all packages

Solution:
This PR will lead to the same header file but automatic as in the pyfar pr
see for an example:
https://pyfar--789.org.readthedocs.build/en/789/pyfar.html

apply to other packegaes

packages under development:

@ahms5 ahms5 requested a review from Copilot April 23, 2025 17:57
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation configuration to change the dropdown behavior in the header, renaming it to "Packages" and adjusting the position of header links.

  • Changed "header_links_before_dropdown" value from 8 to 5.
  • Added "header_dropdown_text" with the value "Packages" to update the dropdown name.

@ahms5 ahms5 moved this from Backlog to Require review in Weekly Planning Apr 23, 2025
@ahms5 ahms5 self-assigned this Apr 23, 2025
@ahms5 ahms5 added the documentation Improvements or additions to documentation label Apr 23, 2025
Copy link
Member

@f-brinkmann f-brinkmann left a comment

Choose a reason for hiding this comment

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

Thanks - should we leave this open for tracking progress in other packages or should we move the to do list to a separate issue?

@github-project-automation github-project-automation bot moved this from Require review to Reviewer Approved in Weekly Planning Apr 24, 2025
Copy link
Member

@hoyer-a hoyer-a left a comment

Choose a reason for hiding this comment

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

thanks for taking care!

@ahms5
Copy link
Member Author

ahms5 commented Apr 25, 2025

one problem could rise in the way we are counting in the above mentiond prs:

        count_gallery_headings = np.sum(
            ['https://pyfar-gallery.readthedocs.io' in line for line in lines])

so apply #104 this would not work anymore, We might need to change the way in automizing it

@ahms5
Copy link
Member Author

ahms5 commented May 9, 2025

released

  • gallery
  • pyfar
  • sofar
  • spharpy
  • pyrato

sofar is released, so we could also release pyfar v0.7.3 to keep it clean milestone v0.7.3 is completed

@f-brinkmann f-brinkmann merged commit 4525803 into main May 30, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from Reviewer Approved to Done in Weekly Planning May 30, 2025
@f-brinkmann f-brinkmann deleted the new_header branch May 30, 2025 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants