History

Steve Howell f6b332ecdb docs: Add linters.md to document our linters. (Also, link to it from the testing docs.)		2016-08-19 11:55:52 -07:00
..
_static	Add CSS style override for RTD to make tables use word wrapping	2015-08-19 11:52:49 -07:00
images	Add HelloWorld webhook integration + Walkthough.	2016-07-29 21:38:40 -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	Fix docs path in docs/README.md.	2016-07-18 12:03:18 -07:00
architecture-overview.md	doc: Add pointer and unread counts guide.	2016-08-16 16:15:38 -07:00
brief-install-vagrant-dev.md	Update links in README and integration guide.	2016-07-19 14:57:07 -07:00
changelog.md	changelog: Clean up some minor text issues.	2016-07-20 20:01:30 -07:00
code-style.md	Extract media queries to media.css.	2016-08-05 10:32:55 -07:00
conf.py	docs: Add missing annotation to conf.py.	2016-08-04 15:57:03 -07:00
conversion.md	export: Update conversion docs.	2016-08-13 09:36:08 -07:00
dev-env-first-time-contributors.md	doc: Recommend provision stream for install help.	2016-08-16 16:22:20 -07:00
directory-structure.md	Fix typos in the documentation.	2016-07-27 13:44:27 -07:00
front-end-build-process.md	Update documentaton to reflect Django-Pipeline==1.6.8.	2016-07-09 07:09:55 -07:00
full-text-search.md	docs: Add some full-text search documentation.	2016-06-26 09:32:54 -07:00
html_css.md	Extract media queries to media.css.	2016-08-05 10:32:55 -07:00
html_unescape.py	Change shebangs from python2.7 to python.	2016-05-29 05:03:08 -07:00
index.rst	Add extensive views writing documentation.	2016-08-18 12:37:33 -07:00
install-docker-dev.md	Split out docker setup doc.	2016-07-19 14:57:07 -07:00
install-generic-unix-dev.md	docs: Fix Fedora secondary links in generic installation.	2016-07-30 21:20:54 -07:00
install-ubuntu-without-vagrant-dev.md	Split non-Vagrant Ubuntu install doc into topic page.	2016-07-19 14:57:07 -07:00
integration-guide.md	integration guide: Move Hello World walkthrough to end.	2016-08-04 15:59:49 -07:00
life-of-a-request.md	Add extensive views writing documentation.	2016-08-18 12:37:33 -07:00
linters.md	docs: Add linters.md to document our linters.	2016-08-19 11:55:52 -07:00
logging.md	Improve first-time contributor docs.	2016-05-31 07:47:45 -07:00
markdown.md	docs: Improve several headings.	2016-06-26 09:54:19 -07:00
migration-renumbering.md	Add docs/migration-renumbering.md	2016-07-18 12:02:50 -07:00
mypy.md	docs/mypy.md: Document zerver/lib/type_debug.py.	2016-07-23 14:38:24 -07:00
new-feature-tutorial.md	docs: Fill gaps in New Feature Tuturial.	2016-08-04 16:02:08 -07:00
pointer.md	Expand pointer and unread counts guide.	2016-08-16 16:17:54 -07:00
prod-auth-first-login.md	Fix typos in the documentation.	2016-07-27 13:44:27 -07:00
prod-authentication-methods.md	docs: Document GitHubAuthBackend.	2016-07-29 15:05:24 -07:00
prod-customize.md	Move prod maintenance guide to new page.	2016-07-12 15:46:10 -07:00
prod-health-check-debug.md	Move prod customization guide to new page.	2016-07-12 15:46:10 -07:00
prod-install.md	Don't use sudo in commands to be run as root.	2016-07-28 15:13:48 -07:00
prod-maintain-secure-upgrade.md	docs: Fix outdated security contact list.	2016-08-17 22:19:53 -07:00
prod-postgres.md	Move prod postgres details to separate page.	2016-07-12 15:46:10 -07:00
prod-requirements.md	doc: Add version number to Trusty in prod requirements.	2016-08-16 16:24:34 -07:00
queuing.md	Update documentation on development auto-reloading.	2016-06-26 20:20:13 -07:00
readme-symlink.md	Rearrange docs table of contents for coherence.	2016-05-31 09:07:09 -07:00
requirements.readthedocs.txt	Move doc building dependencies to requirements/docs.txt.	2016-06-20 16:05:42 -07:00
roadmap.md	Advertise Electron app in documentation.	2016-08-02 16:41:24 -07:00
schema-migrations.md	Link to migration-renumbering.html in schema-migrations.md	2016-07-18 12:02:50 -07:00
settings.md	docs: Add a bit of discussion of settings philosophy.	2016-07-25 11:43:41 -07:00
testing-with-casper.md	docs: Split out Django/Casper/Node testing docs.	2016-08-18 14:10:46 -07:00
testing-with-django.md	docs: Split out Django/Casper/Node testing docs.	2016-08-18 14:10:46 -07:00
testing-with-node.md	docs: Split out Django/Casper/Node testing docs.	2016-08-18 14:10:46 -07:00
testing.md	docs: Add linters.md to document our linters.	2016-08-19 11:55:52 -07:00
translating.md	docs: Cleanup typos and language in translating guide.	2016-07-29 14:49:51 -07:00
using-dev-environment.md	Split developer environment usage instructions into new page.	2016-07-19 14:57:07 -07:00
version-control.md	docs: Split out version control guidelines.	2016-06-26 10:04:06 -07:00
writing-views.md	docs: Add link to life of a request docs on URLs.	2016-08-18 12:41:38 -07:00

README.md

Documentation

These docs are written in Commonmark Markdown with a small bit of rST. We've chosen Markdown because it is easy to write. The docs are served in production at zulip.readthedocs.io.

If you want to build the documentation locally (e.g. to test your changes), the dependencies are automatically installed as part of Zulip development environment provisioning, and you can build the documentation using:

cd docs/
make html

and then opening file:///path/to/zulip/docs/_build/html/index.html in your browser (you can also use e.g. firefox docs/_build/html/index.html from the root of your Zulip checkout).

You can also usually test your changes by pushing a branch to GitHub and looking at the content on the GitHub web UI, since GitHub renders Markdown.

When editing dependencies for the Zulip documentation, you should edit requirements/docs.txt (which is used by ReadTheDocs to build the documentation quickly, without installing all of Zulip's dependencies).