Issue #219: Adds sphinx style docs to be hosted on readthedocs #221
Conversation
This file contains 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
tyronerees
reviewed
Sep 11, 2019
|
|
||
| # General information about the project. | ||
| project = u'FitBenchmarking' | ||
| copyright = u'2019, STFC' |
There was a problem hiding this comment.
Just flagging that this should be amended to be consistent with whatever is said in the new licence, when that appears.
tyronerees
approved these changes
Sep 11, 2019
There was a problem hiding this comment.
All looks good to me -- comes through on https://fitbenchmarking.readthedocs.io, html compiles locally, and so does the pdf.
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.
Description of Work
Prep for #219
Adds rst files to create the start of the structure for the readthedocs documentation.
Also adds a makefile so that documentation can be generated locally using:
cd docsmake htmlTesting Instructions
Attempt to make the docs locally and check that it works correctly