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

Update documentation #482

Closed
purva-thakre opened this issue Feb 23, 2024 · 0 comments · Fixed by #566
Closed

Update documentation #482

purva-thakre opened this issue Feb 23, 2024 · 0 comments · Fixed by #566
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@purva-thakre
Copy link
Collaborator

purva-thakre commented Feb 23, 2024

Some things in the Contributing page and main landing page need updates after the PyPI build was fixed and AutoAPI was introduced.

Will create a list in this issue description before creating a PR.

  • Getting Started and Contributing guides still refers to the build error issue.
  • Add a note in the Getting Started and Contributing guides about known errors with using a Python 3.12 virtual environment. See New conda environment with Python 3.12 leads to installation issues #487
  • Documentation and Adding a new feature sections in the Contributing guide still refer to autoapi.
@purva-thakre purva-thakre self-assigned this Feb 23, 2024
@purva-thakre purva-thakre added the documentation Improvements or additions to documentation label Feb 23, 2024
@purva-thakre purva-thakre added this to the v1.0.8 milestone Feb 24, 2024
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
None yet
Development

Successfully merging a pull request may close this issue.

1 participant