Reorganise install docs #42
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As part of this the contents were translated from markdown to reStructuredText
This was referenced Jun 25, 2020
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes the reorganised installation docs as per our discussion.
It also includes an updated sphinx conf.py (almost identical to labscript-utils barring the outstanding questions on labscript-suite/labscript-utils#51 and a couple of new features I enabled in this PR, see below)
I also added a couple of dependencies to setup.cfg that were missing (but included in docs/requirements.txt). I added them as package dependencies, not optional, because I think they're required (although installed by the other dependencies anyway so didn't throw any errors)
I've enabled TODO notes in the sphinx docs, but these should only render locally and on test RTD projects, not the main project (they should be hidden). Obviously I haven't tested that, but we'll see what happens when we merge.
Other than reorganising the installation instructions, I also added some instructions from creating a conda environment. This was done from my memory from 2 days ago. We should test the whole procedure once the other conda instructions are written.