Skip to content
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

Overhaul Style Guide #2838

Merged
merged 39 commits into from Dec 8, 2016

Conversation

Projects
None yet
2 participants
@stevepiercy
Copy link
Member

commented Nov 26, 2016

This PR addresses issue #2633, and expands the Style Guide as an easy reference for documentation authors.

Request review and feedback.

stevepiercy added some commits Nov 20, 2016

Add Introduction
- add how to update and contribute
- add file conventions
- add line conventions
Merge pull request #2824 from stevepiercy/style-guide
Rename Typographical Conventions to Style Guide
Add moar sections
- trailing white space
- indentation
- split line lengths and paragraphs
Merge pull request #2825 from stevepiercy/style-guide
Add Introduction and other sections
Add Page structure section
- add description
- add introduction
- add headings
- add grammar, spelling, capitalization preferences
Merge pull request #2826 from stevepiercy/style-guide
Add Page structure section
add code block options
- add literal includes
- add displaying long commands
- add sphinx to intersphinx
- garden
Merge pull request #2829 from stevepiercy/style-guide
add literalinclude options
improve include section
- start work on inline and block reST sections
improve links section
- add rendering of headings for testing
- add topic directive
- dedent displaying code
- add italics, strong
- add Pytyon modules, classes, methods, functions
- add tables heading (WIP)
- add API documenation (WIP)
add todo Sphinx extension for todo blocks
- add lists, tables, danger, todo, comments
Merge pull request #2836 from stevepiercy/style-guide
add todo Sphinx extension for todo blocks
replace description with meta
- add parsed-literals
Merge pull request #2837 from stevepiercy/style-guide
Add more sections to the Style Guide

@stevepiercy stevepiercy added the docs label Nov 26, 2016

stevepiercy added some commits Dec 8, 2016

Merge pull request #2858 from stevepiercy/style-guide
update typographical conventions per @bertjwregeer
@stevepiercy

This comment has been minimized.

Copy link
Member Author

commented Dec 8, 2016

@bertjwregeer Updated. I'll merge this evening if there are no further suggestions.

@bertjwregeer

This comment has been minimized.

Copy link
Member

commented Dec 8, 2016

👍 much better. Thanks!

@stevepiercy

This comment has been minimized.

Copy link
Member Author

commented Dec 8, 2016

Thanks for the feedback!

@stevepiercy stevepiercy merged commit 05467bd into master Dec 8, 2016

4 checks passed

continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@stevepiercy stevepiercy deleted the style-guide branch Dec 8, 2016

@stevepiercy stevepiercy referenced this pull request Dec 11, 2016

Closed

Change Typographical Conventions to Style Guide #2633

19 of 19 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.