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

Update docs #3498

Merged
merged 19 commits into from
Feb 18, 2018
8 changes: 2 additions & 6 deletions docs/builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ We will look inside a ``doc`` or ``docs`` directory first,
and then look within your entire project.

Then Sphinx will build any files with an ``.rst`` extension.
If you have a ``README.rst``,
it will be transformed into an ``index.rst`` automatically.

Mkdocs
Copy link
Member Author

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)

Copy link
Member

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/

~~~~~~
Expand All @@ -50,10 +48,8 @@ we will generate one for you.
We will look inside a ``doc`` or ``docs`` directory first,
and then default to the top-level of your documentation.

Then Mkdocs will build any files with an ``.md`` extension.
If you have a ``README.md``,
it will be transformed into an ``index.md`` automatically.
As MkDocs doesn't support automatic PDF generation,
Then MkDocs will build any files with a ``.md`` extension.
As MkDocs doesn't support automatic PDF generation,
Read the Docs cannot create a PDF version of your documentation with the *Mkdocs* option.

Understanding what's going on
Expand Down
27 changes: 26 additions & 1 deletion docs/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the if from "if something"


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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

break them

Copy link
Member

Choose a reason for hiding this comment

The 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.
4 changes: 2 additions & 2 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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
----------------------------------------------------------
---------------------------------------------------------
Copy link
Member

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 :)

Copy link
Member Author

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:

Copy link
Member

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:

captura de pantalla_2018-02-16_09-18-14

Copy link
Member Author

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 :)

Copy link
Member

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?

Copy link
Member Author

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 :)


.. note::
Another use case for this is when you have a module with a C extension.
Expand Down
32 changes: 8 additions & 24 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _installing-read-the-docs:

Installation
=============
============

Here is a step by step plan on how to install Read the Docs.
It will get you to a point of having a local running instance.
Expand Down Expand Up @@ -144,34 +144,18 @@ While the webserver is running, you can build documentation for the latest versi
a project called 'pip' with the ``update_repos`` command. You can replace 'pip'
with the name of any added project::

python manage.py update_repos pip
python manage.py update_repos pip

What's available
----------------

After registering with the site (or creating yourself a superuser account),
you will be able to log in and view the `dashboard <http://localhost:8000/dashboard/>`_.

From the dashboard you can import your existing
docs provided that they are in a git or mercurial repo.
Importing your docs
^^^^^^^^^^^^^^^^^^^


Creating new Docs
^^^^^^^^^^^^^^^^^

One of the goals of `readthedocs.org <http://readthedocs.org>`_ is to make it
easy for any open source developer to get high quality hosted docs with great
visibility! We provide a simple editor and two sample pages whenever
a new project is created. From there its up to you to fill in the gaps - we'll
build the docs, give you access to history on every revision of your files,
and we plan on adding more features in the weeks and months to come.


Importing existing docs
^^^^^^^^^^^^^^^^^^^^^^^

The other side of `readthedocs.org <http://readthedocs.org>`_ is hosting the
docs you've already built. Simply provide us with the clone URL to your repo,
we'll pull your code, extract your docs, and build them! We make available
a post-commit webhook that can be configured to update the docs on our site
whenever you commit to your repo, effectively letting you 'set it and forget it'.
One of the goals of readthedocs.org is to make it easy for any open source developer to get high quality hosted docs with great visibility!
Simply provide us with the clone URL to your repo, we'll pull your code, extract your docs, and build them!
We make available a post-commit webhook that can be configured to update the docs whenever you commit to your repo.
See our :doc:`getting_started` page to learn more.