Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Automate pushing rendered documentation #39

Closed
diego-plan9 opened this issue Jan 15, 2019 · 4 comments
Closed

Automate pushing rendered documentation #39

diego-plan9 opened this issue Jan 15, 2019 · 4 comments
Labels
documentation Something is not clear or error in description

Comments

@diego-plan9
Copy link
Member

In a similar way that terra documentation was handled, we should set up the CI and the project so documentation ends up being pushed to qiskit.org. Ideally:

  • allow keeping both the "stable" documentation (the one relevant to published packages) and the "master" (the one for more bleeding edge users) available (and maybe older versions too?).
  • for chapters where the main content is rendered from notebooks, automate their conversion.
@diego-plan9 diego-plan9 added the documentation Something is not clear or error in description label Jan 15, 2019
@jaygambetta
Copy link
Member

@diego-plan9 and @abdonrd I'm fine if we start doing this now. Each time this repo is updated the doc pushes from docs to qiskit.org/documentation

@diego-plan9
Copy link
Member Author

Sounds good!

@diego-plan9
Copy link
Member Author

After #72, the script for deploying and the travis integration is in place, albeit currently is set to push to a fake directory (and thus not reaching the landing site yet). Next steps are:

  • final tests and deploying the first version of the new documentation
  • add support for handling both master and stable documentation versions

@diego-plan9
Copy link
Member Author

Closing for tracking the remaining issue at #80.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Something is not clear or error in description
Projects
None yet
Development

No branches or pull requests

2 participants