CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-30 21:11:04 +08:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity
54adbb1737
zulip/docs
History
Yoyo Zhou ef50e74873 Fix up rST formatting in code-style.rst. 
- Make all code blocks look like code blocks.
- Eliminate nested inline formatting (rST doesn't support it:
  http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible).
- Punctuation nits.

(imported from commit cd0d780d843b72065678e0f032a2a47d44836adc)
2015-08-18 20:17:47 -07:00
..
.gitignore Initial sphinx setup from sphinx-quickstart 2015-08-18 17:31:32 -07:00
code-style.rst Fix up rST formatting in code-style.rst. 2015-08-18 20:17:47 -07:00
conf.py Use sphinx_rtd_theme when not on ReadTheDocs 2015-08-18 17:31:32 -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 'Code style', generated via pandoc -r mediawiki -w rst and html_unescape.py 2015-08-18 17:34:02 -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

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.