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

Add initial draft for new docs and build with CI #590

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from

Conversation

daurer
Copy link
Contributor

@daurer daurer commented Dec 6, 2024

The new docs are build side-by-side with the old documentation. This means the current documentation will remain available on the same URL while we are slowly migrating over to the new documentation pages.

Old documentation page built with CI: https://daurer.github.io/ptypy-new-docs/legacy
New documentation page: https://daurer.github.io/ptypy-new-docs/master

  • Add CI for documentation serving both old and new docs
  • Configure pydata theme for new sphinx documentation
  • Landing page
  • API reference
  • Parameters
  • Add section for User guide with some content from the old docs
  • Add section for tutorials with full list of examples from ptycho.github.io/tutorials
  • Modify CI to build different versions of the docs (master/dev)
  • Modify CI to aslo build docs on release
  • Add version switcher to new docs

@daurer daurer force-pushed the master branch 2 times, most recently from 4defb25 to cb56494 Compare December 20, 2024 14:04
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.

1 participant