zulip

History

Allie Jones 99a2ba38b1 Expand new feature tutorial.		2015-10-15 09:12:22 -04: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	docs: Fixed a bunch of factual issues in coding style guidelines.	2015-09-22 22:13:28 -07:00
conf.py	Add CSS style override for RTD to make tables use word wrapping	2015-08-19 11:52:49 -07:00
directory-structure.rst	docs: Content editing for directory-structure.rst.	2015-09-22 22:17:56 -07:00
html_unescape.py	Utility for unescaping HTML entities leftover from MediaWiki->rST conversion	2015-08-18 17:31:33 -07:00
index.rst	Remove largely obsolete documentation pages.	2015-09-22 22:37:45 -07:00
new-feature-tutorial.rst	Expand new feature tutorial.	2015-10-15 09:12:22 -04:00
requirements.readthedocs.txt	Add readthedocs requirements.txt.	2015-09-25 10:53:47 -07:00
testing.rst	Reorganize and delete obsolete content from testing.rst.	2015-09-25 03:40:31 -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).