Merge pull request #2534 from rtfd/doc-cleanup

Docs cleanup
hotfix-virtualenv-no-downlaod
Eric Holscher 2016-12-09 13:36:59 -08:00 committed by GitHub
commit 2a54e3adf4
3 changed files with 14 additions and 38 deletions

13
docs/docs.rst Normal file
View File

@ -0,0 +1,13 @@
Building and Contributing to Documentation
==========================================
As one might expect,
the documentation for Read the Docs is built using Sphinx and hosted on Read the Docs.
The docs are kept in the ``docs/`` directory at the top of the source tree.
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.

View File

@ -89,6 +89,7 @@ Information about development is also available:
install
changelog
tests
docs
architecture
development/standards
development/buildenvironments
@ -122,11 +123,3 @@ Information about development is also available:
design
theme
.. _ops-docs:
.. toctree::
:maxdepth: 2
:caption: Operations Documentation
rtfd

View File

@ -1,30 +0,0 @@
Configuration of the production servers
=======================================
This document is to help people who are involved in the production instance of Read the Docs running on readthedocs.org. It contains implementation details and useful hints for the people handling operations of the servers.
Elastic Search Setup
--------------------
You need to install the ICU plugin to make ES work::
# Use the correct path to the plugin executable that ships with ES.
/usr/share/elasticsearch/bin/plugin -install elasticsearch/elasticsearch-analysis-icu/2.3.0
::
from search.indexes import Index, PageIndex, ProjectIndex, SectionIndex
# Create the index.
index = Index()
index_name = index.timestamped_index()
index.create_index(index_name)
index.update_aliases(index_name)
# Update mapping
proj = ProjectIndex()
proj.put_mapping()
page = PageIndex()
page.put_mapping()
sec = SectionIndex()
sec.put_mapping()