Mkdocs setup for arctic #675
Merged
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
|
Build seems to be failing, that's strange given I have added and edited some markdown? |
|
looks like a version change in an underlying library |
|
We should lock down the versions of requirements in setup.py. Would have been easy to figure out in that case. Any guesses which library? |
|
I think I found the culprit. pytest-dev/pytest#4546 |
yschimke
approved these changes
Jan 7, 2019
|
You should consider adding a badge to README. |
|
@femtotrader this commit was more for introducing mkdocs to the repo. Once @jamesblackburn and @bmoscon approve mkdocs, will change README, current wiki, other doc links to point to this. Will add some more FAQ based on the common issues questions and some more documentation on tickstore in that task. |
This sets up the mkdocs yml file for readthedocs documentation. Currently it's setup is at: https://arctic.readthedocs.io/en/latest/
Adds FAQ, adds the pages and some improvements to mkdocs and small edits to the docs.
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.
Adds mkdoc configuration for arctic:
Current status: https://arctic.readthedocs.io/en/latest/