e98f24734c
Sphinx/RTD creates different anchor tags for subheadings than Markdown does, and treats image embedding differently. This commit updates hyperlinks to affected anchors, and fixes an image embed for move to RTD. |
||
|---|---|---|
| .. | ||
| _static | ||
| images | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| architecture-overview.md | ||
| brief-install-vagrant-dev.md | ||
| changelog.md | ||
| code-style.md | ||
| conf.py | ||
| dev-env-first-time-contributors.md | ||
| directory-structure.md | ||
| front-end-build-process.md | ||
| full-text-search.md | ||
| html_css.md | ||
| html_unescape.py | ||
| index.rst | ||
| install-docker-dev.md | ||
| install-generic-unix-dev.md | ||
| install-ubuntu-without-vagrant-dev.md | ||
| integration-guide.md | ||
| logging.md | ||
| markdown.md | ||
| migration-renumbering.md | ||
| mypy.md | ||
| new-feature-tutorial.md | ||
| prod-auth-first-login.md | ||
| prod-authentication-methods.md | ||
| prod-customize.md | ||
| prod-health-check-debug.md | ||
| prod-install.md | ||
| prod-maintain-secure-upgrade.md | ||
| prod-postgres.md | ||
| prod-requirements.md | ||
| queuing.md | ||
| readme-symlink.md | ||
| requirements.readthedocs.txt | ||
| roadmap.md | ||
| schema-migrations.md | ||
| settings.md | ||
| test-suite-dev.md | ||
| testing.md | ||
| translating.md | ||
| using-dev-environment.md | ||
| version-control.md | ||
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).