mirror of
https://github.com/zulip/zulip.git
synced 2026-06-12 21:00:58 +08:00
|
|
||
|---|---|---|
| .. | ||
| _static | ||
| .gitignore | ||
| code-style.rst | ||
| conf.py | ||
| directory-structure.rst | ||
| html_unescape.py | ||
| index.rst | ||
| Makefile | ||
| README.md | ||
| schema-changes.rst | ||
| testing.rst | ||
To create rST from MediaWiki input:
- Use
pandoc -r mediawiki -w rston 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/htmlsubdirectory.