-
Notifications
You must be signed in to change notification settings - Fork 13
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
Import augur auto-generated API docs #10
Comments
naive first attempt not using submodules
Oops, the commit message there is supposed to say "naive first attempt not using |
previously for the auto-generated augur docs, we imported them using git submodules as with other docs imported from other repos. In order to preserve the augur versioning of those auto-generated API docs, this uses read the docs subprojects instead.
a157213 changes the reference/augur heading in the sidebar to a link to https://docs.nextstrain.org/projects/augur/en/migrate-docs/index.html, where all augur reference documents have been consolidated into the augur subproject (and all non-reference documents are not listed / rendered in the subproject or its sidebar since they are instead imported via the git submodule and listed / rendered in the main project). |
following precedent of: nextstrain/docs.nextstrain.org#10 (comment)
this follows the example of #10 (comment)
This is done for now using subprojects. If #27 pans out, there will be some work again here to change implementation of including these docs so that they show up in this project's table of contents / sidebar instead of having to navigate to a separate url to get to the augur subproject. |
following precedent of: nextstrain/docs.nextstrain.org#10 (comment)
This is a progress-tracker type issue to track the incorporation of augur auto-generated API documentation which is currently rendered at https://docs.nextstrain.org/projects/augur/en/stable/api/api.html.
I believe we want to use read the docs subprojects for in order to have versioned documentation -- e.g.preserve the API docs for each different augur version & access it via a URL.
The text was updated successfully, but these errors were encountered: