zulip

History

Tim Abbott 672a431fba Expand documentation on tools/check-py3.		2016-04-25 16:46:46 -07:00
..
_static	Add CSS style override for RTD to make tables use word wrapping	2015-08-19 11:52:49 -07:00
.gitignore	Initial sphinx setup from sphinx-quickstart	2015-08-18 17:31:32 -07:00
Makefile	Initial sphinx setup from sphinx-quickstart	2015-08-18 17:31:32 -07:00
README.md	Improve docs/README.md	2015-08-22 12:53:54 -07:00
code-style.rst	Update memcache -> remote cache in inline documentation.	2016-03-31 12:56:42 -07:00
conf.py	Add new markdown documentation to ReadTheDocs.	2016-04-01 14:57:30 -07:00
directory-structure.rst	Fix formatting in directory-structure.rst.	2016-04-13 15:44:10 -07:00
front-end-build-process.rst	Expand documentation on frontend build process.	2016-04-01 09:56:59 -07:00
html_unescape.py	Fix parsing html_unescape.py in py3k test.	2016-01-09 15:43:30 -08:00
index.rst	Add new markdown documentation to ReadTheDocs.	2016-04-01 14:57:30 -07:00
integration-guide.md	Integration guide: Expand instructions on screenshots.	2016-04-21 18:17:26 -07:00
markdown.md	Move Zulip backend tests to zerver.tests.	2016-04-11 22:16:09 -07:00
new-feature-tutorial.rst	Move Zulip backend tests to zerver.tests.	2016-04-11 22:16:09 -07:00
queuing.md	Add documentation on the Zulip RabbitMQ queues.	2016-04-01 09:56:59 -07:00
requirements.readthedocs.txt	Add readthedocs requirements.txt.	2015-09-25 10:53:47 -07:00
schema-migrations.md	Add some docs on schema migrations.	2016-04-01 09:57:00 -07:00
testing.rst	Expand documentation on tools/check-py3.	2016-04-25 16:46:46 -07:00

README.md

These docs are written in rST, and are included on the zulip.org website as well as on each development installation. Many of these docs have been ported from the internal docs of Zulip Inc., and may need to be updated for use in the open source project.

To generate HTML docs locally from rST:

pip install sphinx
In this directory, make html. Output appears in a _build/html subdirectory.

To create rST from MediaWiki input:

Use pandoc -r mediawiki -w rst on MediaWiki source.
Use unescape.py to remove any leftover HTML entities (often inside
```
tags and the like).
```

We can use pandoc to translate mediawiki into reStructuredText, but some things need fixing up:

Add page titles.
Review pages for formatting (especially inline code chunks) and content.
Fix wiki links?
Add pages to the table of contents (index.rst).