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 docs #1279

Merged
merged 13 commits into from
Oct 1, 2024
Merged

Update docs #1279

merged 13 commits into from
Oct 1, 2024

Conversation

WeilerP
Copy link
Member

@WeilerP WeilerP commented Oct 1, 2024

Changes

  • Update paper referencing
  • Update Sphinx config
  • Update docstrings

Bug fixes

  • Fix hyper refs to notebooks

Related issues

Closes #1272. Closes #1278.

Update to latest sphinx version.
Replace `Arguments:` by `Parameters`
Removes `pca` which is merely imported from and defined in Scanpy.
Fix notebook linking.
- Remove reference to veloVI.
- Update bibtex references
- Update list of references.
- Use consistent ID `AuthorYY` for references.
- Properly cite papers in docstrings.
- Remove `pca`.
- Add empty line for consistent formatting.
Refactor sphinx config.
Update type hint of argument `format`.
Fix import of removed `pca` function.
Update docs according to latest changes; The syntax `scv.read` no longer
works and needs to be used with Scanpy directly.
@WeilerP WeilerP merged commit 77e6b49 into theislab:main Oct 1, 2024
4 of 6 checks passed
@WeilerP WeilerP deleted the feat/update_docs branch October 1, 2024 13:19
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.

Update how documentation is built Notebook links in documentation are broken
1 participant