Skip to content

Conversation

@jorgepiloto
Copy link
Member

@jorgepiloto jorgepiloto commented Nov 22, 2023

This pull-request implements a gallery of examples in the documentation pages. Main changes include:

  • Installing pandoc during the CI/CD from official CentOS7 repositories
  • Running the doc-build job in the self-hosted runner
  • Remove cell numbering, margins, and increase font size to 1rem
  • Use Sphinx hooks to host the examples/ dir at the root directory of the project
  • Enable script and notebook download links
  • Option to render widgets in Jupyter sidecar

Gallery of examples with multiple sections and thumbnails

Screenshot 2023-12-22 at 15-58-46 Examples — PySTK

Download buttons get automatically included at the begging of every example

Screenshot 2023-12-22 at 15-53-30 Hohmann transfer using targeter — PySTK

@github-actions github-actions bot added docs:examples Related to documentation examples ci Pipelines maintenance related labels Nov 22, 2023
@jorgepiloto jorgepiloto force-pushed the doc/examples branch 6 times, most recently from b86d0bc to 8b61254 Compare December 23, 2023 08:58
@jorgepiloto
Copy link
Member Author

I just found that Python scripts can also be opened directly in Jupyter Lab. These scripts are rendered as notebooks instead of plain scripts. This are great news! It allows to get rid of some deps and reduces the complexity for newcomers. Performing another iteration on this...

@jorgepiloto jorgepiloto marked this pull request as ready for review January 11, 2024 14:17
@jorgepiloto jorgepiloto requested a review from a team as a code owner January 11, 2024 14:17
@jorgepiloto jorgepiloto marked this pull request as draft January 11, 2024 14:17
@jorgepiloto jorgepiloto force-pushed the doc/examples branch 2 times, most recently from e1c25f7 to 0d643bf Compare January 15, 2024 11:12
Copy link
Contributor

@davegouger davegouger left a comment

Choose a reason for hiding this comment

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

Only one very minor comment about hyphenating "step-by-step." in index.rst. I thought I had changed that recently but it looks like I may have missed it.

@jorgepiloto jorgepiloto force-pushed the doc/examples branch 2 times, most recently from 867e406 to bdff699 Compare February 13, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Pipelines maintenance related docs:examples Related to documentation examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants