-
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 auspice docs #8
Comments
If the current state of the augur subproject / submodule set up [1] is to serve as a precedent / template for auspice, we should create a read the docs subproject for auspice, which builds from the documents in the auspice git repo and displays reference material in a distinct RTD domain, presumably [1] #10 (comment) |
As part of our migration of all nextstrain-docs to RTD and docs.nextstrain.org this commit switches Auspice to using RTD. There is further work needed in terms of organisation structure, using pages here under docs.nextstrain.org's RTD page (as opposed to the Auspice subproject), but this migration paves the way. No content changes, but lots of syntax changes etc See nextstrain/docs.nextstrain.org#8 for context.
#19 achieves this -- @eharkins could you create a RTD domain for auspice using that? (There's still work to be done -- that PR just migrates auspice to RTD, it doesn't modify the contents structure at all) |
this adds documents from the auspice submodule by adding paths to those documents in the toctree(s) of this project thereby including them in the sidebar for docs.nextstrain.org
this follows the example of #10 (comment)
This is a progress-tracker type issue to track the incorporation of auspice documentation into docs.nextstrain.org. The current docs are stored at https://github.com/nextstrain/auspice/tree/master/docs-src/docs, are in markdown format (with YAML frontmatter) and are rendered at https://nextstrain.github.io/auspice. The gdoc contains a mapping of how they shall fit into the new docs TOC structure
The text was updated successfully, but these errors were encountered: