zulip/docs at d0afb75619b764942af517daad76537a4b78a139 - zulip - Git

History

David Roe 3f7cb34b00 enterprise => voyager (imported from commit 04be792bb480d5e5db1c91d296d1000cf1682571)		2015-08-21 10:33:35 -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	Add 'Code style', generated via pandoc -r mediawiki -w rst and html_unescape.py	2015-08-18 17:34:02 -07:00
code-style.rst	deployed => production	2015-08-21 10:33:35 -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	enterprise => voyager	2015-08-21 10:33:35 -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	Add "Schema changes", rST generated via pandoc -r mediawiki -w rst	2015-08-20 14:24:59 -07:00
schema-changes.rst	Update schema changes content and formatting.	2015-08-20 14:24:59 -07:00
testing.rst	Add note that provision.py sets up postgres test db for you	2015-08-20 14:21:55 -07:00

README.md

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).

To generate HTML docs locally from RST:

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