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

documentation rehaul #120

Open
wants to merge 25 commits into
base: v1.0.0
Choose a base branch
from
Open

documentation rehaul #120

wants to merge 25 commits into from

Conversation

hzheng40
Copy link
Member

@hzheng40 hzheng40 commented Mar 3, 2024

  1. got rid of doxygen static xmls
  2. now use autosummary to generate docs
  3. numpy doc styling
  4. deployment is updated on readthedocs

see page here to preview

@luigiberducci
Copy link
Collaborator

@hzheng40 "Getting started" documentation is ready. Please check 🙏

@hzheng40 hzheng40 marked this pull request as ready for review April 19, 2024 01:57
@hzheng40
Copy link
Member Author

The docs still need some more details in the getting started section but it's a good skeleton now. Ready to merge into v1.0.0.

@nandantumu please double check if the changes for poetry and pyproject.toml makes sense.

@hzheng40 hzheng40 requested a review from nandantumu April 19, 2024 01:59
@hzheng40 hzheng40 mentioned this pull request Apr 19, 2024
@luigiberducci luigiberducci self-assigned this Apr 26, 2024
@nandantumu nandantumu self-assigned this Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants