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

Link API docs to libtopotoolbox docs #37

Open
wkearn opened this issue Jun 17, 2024 · 0 comments
Open

Link API docs to libtopotoolbox docs #37

wkearn opened this issue Jun 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@wkearn
Copy link
Contributor

wkearn commented Jun 17, 2024

We should explain in greater detail what each function is doing, and we might want to link to the libtopotoolbox documentation to avoid duplicating this information. We could obviously just use html links between the documentation, but those might break easily, so require manually synchronizing the pytopotoolbox docs with the libtopotoolbox docs. Maybe there is a better way to link between them that uses the common Sphinx infrastructure?

@wkearn wkearn added the documentation Improvements or additions to documentation label Jun 17, 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

No branches or pull requests

1 participant