zulip

History

Tim Abbott ecc66d6eec code style: Improve the commit message style documentation.		2016-03-19 10:09:21 -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	code style: Improve the commit message style documentation.	2016-03-19 10:09:21 -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	Move frontend tests out of zerver/tests/.	2015-10-28 10:11:47 -07:00
front-end-build-process.rst	Add documentation on the front end build process and webpack.	2015-11-20 20:32:01 -08:00
html_unescape.py	Fix parsing html_unescape.py in py3k test.	2016-01-09 15:43:30 -08:00
index.rst	Add documentation on the front end build process and webpack.	2015-11-20 20:32:01 -08: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	Fixed a typo in documentation.	2016-03-17 22:53:42 -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).