Skip to content

A few doc updates to address bugs #2712

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 7 commits into from
Mar 9, 2017
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.mit
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2011 Charles Leifer, Eric Holscher, Bobby Grace
Copyright (c) 2010-2017 Read the Docs, Inc & contributors

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand Down
5 changes: 4 additions & 1 deletion docs/alternate_domains.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,12 @@ This requires two steps:
* Add a CNAME record in your DNS that point to our servers `readthedocs.io`
* Add a Domain object in the **Project Admin > Domains** page for your project.

.. note:: The ``Domain`` that should be used is the actual subdomain that you want your docs served on.
Generally it will be `docs.projectname.org`.

Using pip as an example, http://www.pip-installer.org resolves, but is hosted on our infrastructure.

As an example, fabric's dig record looks like this::
As another example, fabric's dig record looks like this::

-> dig docs.fabfile.org
...
Expand Down
3 changes: 3 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Read the Docs Public API
We have a limited public API that is available for you to get data out of the site.
This document covers only part of the API provided. We have plans to create a read/write API, so that you can easily automate interactions with your project.

.. warning:: This API is out of date and not currently maintained.
We have a v2 API that is in better repair available at http://readthedocs.org/api/v2/.
Copy link
Member

@humitos humitos Mar 9, 2017

Choose a reason for hiding this comment

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

is in better repair available, is that phrase correct? I'm not sure to understand what it means.


A basic API client using slumber
--------------------------------

Expand Down
4 changes: 4 additions & 0 deletions docs/builds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Our current build limits are:
We can increase build limits on a per-project basis,
if you provide a good reason your documentation needs more resources.

You can see the current Docker build images that we use in our `docker repository <https://github.com/rtfd/readthedocs-docker-images>`_. `Docker Hub <https://hub.docker.com/r/readthedocs/build/>`_ also shows the latest set of images that have been built.

Currently in production we're using the ``readthedocs/build:2.0`` docker image as our default image.

How we build documentation
--------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

master_doc = 'index'
project = u'Read The Docs'
copyright = u'2010, Eric Holscher, Charlie Leifer, Bobby Grace'
copyright = u'2010-2017, Read the Docs, Inc & contributors'
version = '1.0'
release = '1.0'
exclude_patterns = ['_build']
Expand Down
3 changes: 3 additions & 0 deletions docs/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ Triaging tickets
Here is a brief explanation on how we triage incoming tickets to get a better
sense of what needs to be done on what end.

.. note:: You will need Triage permission on the project in order to do this.
You can ask one of the members of the :doc:`team` to give you access.

Initial triage
~~~~~~~~~~~~~~

Expand Down
12 changes: 5 additions & 7 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,6 @@ Deleting a stale or broken build environment

If you're having trouble getting your version to build, try wiping out the existing build/environment files. On your version list page ``/projects/[project]/versions`` there is a "Wipe" button that will remove all of the files associated with your documentation build, but not the documentation itself.



How do I host multiple projects on one CNAME?
---------------------------------------------

Expand Down Expand Up @@ -151,11 +149,6 @@ How do I support multiple languages of documentation?

See the section on :ref:`Localization of Documentation`.

Do I need to be whitelisted?
----------------------------

No. Whitelisting has been removed as a concept in Read the Docs. You should have access to all of the features already.

Does Read The Docs work well with "legible" docstrings?
-------------------------------------------------------

Copy link
Member

Choose a reason for hiding this comment

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

Why did you remove this one?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's years old, and talks about something that hasn't existed for a long time.

Expand Down Expand Up @@ -207,3 +200,8 @@ file* field.

.. _Sphinx's autoapi: http://sphinx-doc.org/ext/autodoc.html
.. _pip requirements file: https://pip.pypa.io/en/stable/user_guide.html#requirements-files

What commit of Read the Docs is in production?
----------------------------------------------

We deploy readthedocs.org from the `rel` branch in our GitHub repository. You can see the latest commits that have been deployed by looking on GitHub: https://github.com/rtfd/readthedocs.org/commits/rel