zulip/docs at a9023935e45d1f5b926e3766b38f2f8c314e2f6c - zulip - Git

History

Yoyo Zhou 6e55b4df8a Update directory-structure.rst content to fix internal references - Delete references to zilencer - Replace "local server" references - Add directories for message views, frontend templates/tests, and docs (imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)		2015-08-19 11:52:49 -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	Directory structure generated from pandoc, with formatting fixes	2015-08-19 11:52:49 -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.