zulip/docs at 1e3249c94eea229dfd53702b922de2d4d2bae4a7 - zulip - Git

History

Yoyo Zhou 1e3249c94e Add note that provision.py sets up postgres test db for you (imported from commit 87d31b04db15b8ea994f40362ab910ccc028c91a)		2015-08-20 14:21:55 -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	Fix up rST formatting in code-style.rst.	2015-08-18 20:17:47 -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	Update directory-structure.rst content to fix internal references	2015-08-19 11:52:49 -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	Copy "Testing the app" from the wiki, via pandoc -r mediawiki -o rst	2015-08-20 14:21:55 -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.