-
-
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
Update docs #3498
Changes from 16 commits
a3871e3
dd24d42
7cf9f9c
6e59fd0
d907524
9cf1742
484377b
6f86eec
ec70855
344ec5c
8c46050
4cc4d46
b2f6656
99ced33
a230278
db2c67a
ae9acc6
57fd486
c870ceb
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,4 +10,29 @@ You can build the docs by installing ``Sphinx`` and running:: | |
# in the docs directory | ||
make html | ||
|
||
Let us know if you have any questions or want to contribute to the documentation. | ||
Please follow these guidelines when updating our docs. | ||
Let us know if you have any questions or if something isn't clear. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove the |
||
|
||
The brand | ||
--------- | ||
|
||
We are called **Read the Docs**. | ||
The *the* is not capitalized. | ||
|
||
We do however use the acronym **RTD**. | ||
|
||
Titles | ||
------ | ||
|
||
For page titles, or Heading1 as they are sometimes called, we use title-case. | ||
|
||
If the page includes multiple sub-headings (H2, H3), | ||
we usually use sentence-case unless the titles include terminology that is supposed to be capitalized. | ||
|
||
Content | ||
------- | ||
|
||
* Do not break the content across multiple lines at 80 characters, | ||
but rather broken them on semantic meaning (e.g. periods or commas). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. break them There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, I think it would be awesome to link the post that Eric shared with you. You said that was useful to understand this idea, so may be good to link it here. |
||
* If you are cross-referencing to a different page within our website, | ||
use the ``doc`` directive and not a hyperlink. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,7 +23,7 @@ as it `breaks the internet <http://www.w3.org/Provider/Style/URI.html>`_. | |
Help, my build passed but my documentation page is 404 Not Found! | ||
----------------------------------------------------------------- | ||
|
||
This often happens becuase you don't have an `index.html` file being generated. | ||
This often happens because you don't have an `index.html` file being generated. | ||
Make sure you have one of the following files: | ||
|
||
* `index.rst` | ||
|
@@ -57,7 +57,7 @@ environment, and will be set to ``True`` when building on RTD:: | |
{% endif %} | ||
|
||
I get import errors on libraries that depend on C modules | ||
---------------------------------------------------------- | ||
--------------------------------------------------------- | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 commentThe 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 commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 commentThe 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 commentThe reason will be displayed to describe this comment to others. Learn more. Sure, I opened a new issue #3622, I will implemented later :) |
||
|
||
.. note:: | ||
Another use case for this is when you have a module with a C extension. | ||
|
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.
Should be MkDocs? (uppercase D)
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.
Yeah, that's the correct way of writting it: http://www.mkdocs.org/