-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Update docs #3498
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
Merged
Merged
Update docs #3498
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
a3871e3
Update "What's available" section
stsewd dd24d42
Change title
stsewd 7cf9f9c
Add link to getting started page
stsewd 6e59fd0
Wrap to 80 characters
stsewd d907524
Remove note about changing README to index
stsewd 9cf1742
Wrap to 80 characters
stsewd 484377b
Fix typo
stsewd 6f86eec
Wrap to 80 characters
stsewd ec70855
Add styleguide for docs
stsewd 344ec5c
Revert "Wrap to 80 characters"
stsewd 8c46050
Revert "Wrap to 80 characters"
stsewd 4cc4d46
Revert "Wrap to 80 characters"
stsewd b2f6656
Fix header
stsewd 99ced33
Fix header
stsewd a230278
Fix indentation
stsewd db2c67a
Style
stsewd ae9acc6
More style changes
stsewd 57fd486
Rename Mkdocs to MkDocs
stsewd c870ceb
Fix grammar
stsewd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you remove this for some reason? Just curious :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@humitos the header is larger than the text p:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, that's OK. Github doesn't show it in a monospace font for some reason:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I use rstcheck for linting rst files :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow! I didn't know it and I'm a fan of @myint.
Considering that we are talking about the documentation style, I think it would be a good addition for travis checks and linting right? I mean, trigger a linting on the docs on travis checks.
Would you like to add an issue for this and take a look on what's needed and how to implement it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I opened a new issue #3622, I will implemented later :)