/pyramid

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

Reviewers
No reviews
Assignees

@stevepiercy stevepiercy

Labels
Projects
None yet
Milestone
  1.8
2 participants
@stevepiercy @bertjwregeer
@stevepiercy
Member

stevepiercy 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

@stevepiercy
Rename Typographical Conventions to Style Guide
Loading status checks…
fb88f05
@stevepiercy
Add Introduction 
- add how to update and contribute
- add file conventions
- add line conventions
Loading status checks…
8cc4f78
@stevepiercy
Merge pull request #2824 from stevepiercy/style-guide 
Rename Typographical Conventions to Style Guide
Loading status checks…
d204595
@stevepiercy
Add moar sections 
- trailing white space
- indentation
- split line lengths and paragraphs
Loading status checks…
18a6375
@stevepiercy
Merge pull request #2825 from stevepiercy/style-guide 
Add Introduction and other sections
Loading status checks…
d236a70
@stevepiercy
Add Page structure section 
- add description
- add introduction
- add headings
- add grammar, spelling, capitalization preferences
Loading status checks…
f69e903
@stevepiercy
Merge pull request #2826 from stevepiercy/style-guide 
Add Page structure section
Loading status checks…
8abaf3c
@stevepiercy
Add section structure
7285651
@stevepiercy
update headings
2954362
@stevepiercy
add links
c13e6cc
@stevepiercy
add topic
e33b2ce
@stevepiercy
add syntax highlighting
ff8acd6
@stevepiercy
add code block options 
- add literal includes
- add displaying long commands
- add sphinx to intersphinx
- garden
Loading status checks…
90db2bc
@stevepiercy
Merge pull request #2828 from stevepiercy/style-guide 
More style guide updates
Loading status checks…
afce288
@stevepiercy
add literalinclude options
Loading status checks…
60ff6ab
@stevepiercy
Merge pull request #2829 from stevepiercy/style-guide 
add literalinclude options
Loading status checks…
2e62254
@stevepiercy
improve include section 
- start work on inline and block reST sections
cdee90a
@stevepiercy
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)
Loading status checks…
a7f3065
@stevepiercy
comment out autodoc of TranslationString to get docs to build on Trav… 
…is-CI

https://travis-ci.org/Pylons/pyramid/jobs/178536008#L406
Loading status checks…
88dd1fc
@stevepiercy
Merge pull request #2833 from stevepiercy/style-guide 
more style guide updates
Loading status checks…
faf4ab2
@stevepiercy
add todo Sphinx extension for todo blocks 
- add lists, tables, danger, todo, comments
Loading status checks…
bf5c9ea
@stevepiercy
Merge pull request #2836 from stevepiercy/style-guide 
add todo Sphinx extension for todo blocks
Loading status checks…
478b439
@stevepiercy
replace description with meta 
- add parsed-literals
f4518e7
@stevepiercy
add feature versioning, seealso
78254d4
@stevepiercy
add glossary
d586ff5
@stevepiercy
add toctree
d1d6a7d
@stevepiercy
add cross-referencing
d7a6a90
@stevepiercy
add sphinx extensions
Loading status checks…
d7150db
@stevepiercy
Merge pull request #2837 from stevepiercy/style-guide 
Add more sections to the Style Guide
Loading status checks…
c6b5b95

@stevepiercy stevepiercy added the docs label Nov 26, 2016

@stevepiercy
Merge pull request #2858 from stevepiercy/style-guide 
update typographical conventions per @bertjwregeer
Loading status checks…
e5add4c
@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Dec 8, 2016

Member

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

stevepiercy commented Dec 8, 2016

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

This comment has been minimized.

Show comment
Hide comment
@bertjwregeer

bertjwregeer Dec 8, 2016

Member

👍 much better. Thanks!
Member

bertjwregeer commented Dec 8, 2016

👍 much better. Thanks!
@stevepiercy

This comment has been minimized.

Show comment
Hide comment
@stevepiercy

stevepiercy Dec 8, 2016

Member

Thanks for the feedback!
Member

stevepiercy commented Dec 8, 2016

Thanks for the feedback!

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

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

This was referenced Jan 22, 2017

Closed
Closed
Closed

@pyup-bot pyup-bot referenced this pull request Feb 26, 2017

Merged

Pin pyramid to latest version 1.8.2 #35

@pyup-bot pyup-bot referenced this pull request Apr 30, 2017

Merged

Pin pyramid to latest version 1.8.3 #94

This was referenced Jun 26, 2017

Closed
Merged

This was referenced Jul 3, 2017

Closed
Closed
Closed
Closed

This was referenced Jul 10, 2017

Closed
Open
Closed

@pyup-bot pyup-bot referenced this pull request Jul 24, 2017

Closed

Scheduled weekly dependency update for week 30 #346

This was referenced Sep 29, 2017

Merged
Closed
Merged

@pyup-bot pyup-bot referenced this pull request Dec 12, 2017

Merged

Pin pyramid to latest version 1.9.1 #6

@friendly-test-bot friendly-test-bot referenced this pull request Feb 5, 2018

Open

Update pyramid to 1.9.1 #41

This was referenced Feb 20, 2018

Closed
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment