Skip to content

Conversation

@janbridley
Copy link
Collaborator

@janbridley janbridley commented Jan 16, 2025

Description

Sphinx directives are not supported in GitHub readme files. Once the docs are public, the sphinx-generated links can be replaced with links to the readthedocs. This could be done now, but would result in some duplication of effort without significant benefit

Motivation and Context

Resolves #32

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality and should be merged into the breaking branch

Checklist:

  • I am familiar with the Development Guidelines
  • The changes introduced by this pull request are covered by existing or newly introduced tests.
  • I have updated the changelog and added my name to the credits.

@janbridley
Copy link
Collaborator Author

Completed in Release 0.2.0

@janbridley janbridley closed this Mar 11, 2025
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.

Replace README.rst sphinx directive links with links to the real documentation

2 participants