paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs/README.md

Browse Source 
(imported from commit 78193958bdb5f92ae5d8706340a739dae0da5367)
This commit is contained in:
David Roe
2015-08-21 12:11:24 -07:00
committed by Tim Abbott
parent 2e5c82203d
commit 1a3bc517d9
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/README.md
View File

@@ -1,3 +1,13 @@
These docs are written in rST, and are included on the zulip.org website
as well as on each development installation. Many of these docs
have been ported from the internal docs of Zulip Inc.,
and may need to be updated for use in the open source project.
To generate HTML docs locally from rST:
* `pip install sphinx`
* In this directory, `make html`. Output appears in a `_build/html` subdirectory.
To create rST from MediaWiki input: To create rST from MediaWiki input:
* Use `pandoc -r mediawiki -w rst` on MediaWiki source. * Use `pandoc -r mediawiki -w rst` on MediaWiki source.
@@ -11,7 +21,3 @@ We can use pandoc to translate mediawiki into reStructuredText, but some things
* Fix wiki links? * Fix wiki links?
* Add pages to the table of contents (`index.rst`). * 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.