zulip

History

Tim Abbott c9ef726048 docs/mypy: Add note about Zulip's annotation goals.		2016-06-10 16:30:14 -07:00
..
_static	Add CSS style override for RTD to make tables use word wrapping	2015-08-19 11:52:49 -07:00
images	Improve first-time contributor docs.	2016-05-31 07:47:45 -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	Improve docs/README.md	2015-08-22 12:53:54 -07:00
architecture-overview.md	Convert architecture overview from rST to md for consistency.	2016-06-04 22:27:00 -07:00
changelog.md	Update changelog with important changes since last release.	2016-05-31 11:39:47 -07:00
code-contribution-checklist.rst	Rearrange docs table of contents for coherence.	2016-05-31 09:07:09 -07:00
code-style.md	Docs: Fix typos in docs.	2016-06-02 10:31:41 -07:00
conf.py	Make docs/conf.py pass mypy check.	2016-05-25 15:04:39 -07:00
directory-structure.md	Remove rST files to replace with Markdown.	2016-05-31 10:55:49 -07:00
front-end-build-process.md	Remove rST files to replace with Markdown.	2016-05-31 10:55:49 -07:00
html_unescape.py	Change shebangs from python2.7 to python.	2016-05-29 05:03:08 -07:00
index.rst	Add architectural overview documentation.	2016-06-03 11:54:02 -07:00
integration-guide.md	Remove rST files to replace with Markdown.	2016-05-31 10:55:49 -07:00
logging.md	Improve first-time contributor docs.	2016-05-31 07:47:45 -07:00
markdown.md	Docs: Fix typos in docs.	2016-06-02 10:31:41 -07:00
mypy.md	docs/mypy: Add note about Zulip's annotation goals.	2016-06-10 16:30:14 -07:00
new-feature-tutorial.md	Docs: Fix typos in docs.	2016-06-02 10:31:41 -07:00
queuing.md	Add documentation on the Zulip RabbitMQ queues.	2016-04-01 09:56:59 -07:00
readme-symlink.md	Rearrange docs table of contents for coherence.	2016-05-31 09:07:09 -07:00
requirements.readthedocs.txt	docs: Add python-tyoing to RTD dependencies.	2016-05-31 11:19:49 -07:00
roadmap.md	Docs: Fix typos in docs.	2016-06-02 10:31:41 -07:00
schema-migrations.md	Add some docs on schema migrations.	2016-04-01 09:57:00 -07:00
testing.md	Docs: Fix typos in docs.	2016-06-02 10:31:41 -07:00
translating.md	Add documentation for json_error and JsonableError.	2016-06-04 18:48:32 -07:00

README.md

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:

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).