Eklavya Sharma
d9c4be87d1
Make docs/conf.py pass mypy check.
2016-05-25 15:04:39 -07:00
Umair Khan
82b5d9304b
[third] Integrate i18next with Handlebars
2016-05-19 22:58:25 -07:00
Umair Khan
f9bbc5d6ff
Enable i18n support in URL configuration.
...
This supports i18n using all of the following:
- I18N urls
- Session
- Cookie
- HTTP header
2016-05-19 08:33:30 -07:00
Tim Abbott
b38913c8f9
Upgrade sphinx version used in ReadTheDocs.
...
According to https://github.com/spatialaudio/nbsphinx/issues/26 , this
should fix support for mixing rST and markdown in our docs.
Fixes #668 .
2016-05-14 14:27:21 -07:00
Tim Abbott
60722a8fce
Integration guide: Add a note about spelling integraiton names.
2016-05-11 21:19:15 -07:00
Tomasz Kolek
eeeb4d0c92
Add CircleCI integration.
...
Fixes : #617 .
2016-05-11 21:17:37 -07:00
Tim Abbott
92bec8cfea
Merge Zulip 1.3.12 security release.
2016-05-10 11:32:26 -07:00
Umair Khan
0d324925b5
Add documentation on translation tags.
...
[substantially modified by tabbott]
2016-05-09 09:55:18 -07:00
Umair Khan
5359e6b0d4
Convert Zulip to use Jinja2 templates.
...
This results in a substantial performance improvement for all of
Zulip's backend templates.
Changes in templates:
- Change `block.super` to `super()`.
- Remove `load` tag because Jinja2 doesn't support it.
- Use `minified_js()|safe` instead of `{% minified_js %}`.
- Use `compressed_css()|safe` instead of `{% compressed_css %}`.
- `forloop.first` -> `loop.first`.
- Use `{{ csrf_input }}` instead of `{% csrf_token %}`.
- Use `{# ... #}` instead of `{% comment %}`.
- Use `url()` instead of `{% url %}`.
- Use `_()` instead of `{% trans %}` because in Jinja `trans` is a block tag.
- Use `{% trans %}` instead of `{% blocktrans %}`.
- Use `{% raw %}` instead of `{% verbatim %}`.
Changes in tools:
- Check for `trans` block in `check-templates` instead of `blocktrans`
Changes in backend:
- Create custom `render_to_response` function which takes `request` objects
instead of `RequestContext` object. There are two reasons to do this:
1. `RequestContext` is not compatible with Jinja2
2. `RequestContext` in `render_to_response` is deprecated.
- Add Jinja2 related support files in zproject/jinja2 directory. It
includes a custom backend and a template renderer, compressors for js
and css and Jinja2 environment handler.
- Enable `slugify` and `pluralize` filters in Jinja2 environment.
Fixes #620 .
2016-05-09 09:55:18 -07:00
Preston Hansen
635828069f
Add feature to mark all in stream/topic as read with mouse.
...
Fixes #736 .
2016-05-08 09:02:46 -07:00
Tim Abbott
34fb276b7b
changelog: Add some items since the last release.
2016-05-07 20:34:14 -07:00
Tim Abbott
c5a44043a8
Cleanup changelog.md to be better documentation.
2016-05-07 20:34:06 -07:00
Tim Abbott
1c24cb32a5
Move changelog.md to docs/ and add to ReadTheDocs.
2016-05-07 20:26:44 -07:00
Tim Abbott
e5e133eccc
Update docs to reflect the elimination of /bin.
2016-05-07 19:37:06 -07:00
Tim Abbott
d20791eb6a
docs/new-feature-tutorial: Fix typos in templates path.
2016-05-07 17:37:01 -07:00
Tim Abbott
f06c8c7cc2
Update *.readthedocs.org => *.readthedocs.io.
...
ReadTheDocs has moved their hosting of user project websites to the
new readthedocs.io domain.
2016-04-29 16:00:08 -07:00
Tim Abbott
362a622f1f
Add documentation on translating Zulip.
2016-04-28 21:57:10 -07:00
Tim Abbott
27b8e8b294
Add the Zulip 2016 roadmap document.
2016-04-28 21:55:33 -07:00
Eklavya Sharma
b60141fd84
Add documentation on the using the mypy static type checker.
...
[with substantial tweaks by tabbott]
2016-04-28 12:29:45 -07:00
Eklavya Sharma
22d407fe0b
docs/testing.rst: Fix typo and name of a package.
...
* Remove duplicate words.
* Replace `futurize` by `future`.
2016-04-28 15:19:22 +05:30
Tim Abbott
abacd9b2da
Integration guide: Document need to edit urls.py.
2016-04-26 11:50:19 -07:00
Tim Abbott
672a431fba
Expand documentation on tools/check-py3.
2016-04-25 16:46:46 -07:00
Eklavya Sharma
ae46d425b6
Add info about tools/check-py3 in docs/testing.rst.
...
Fixes #701 .
2016-04-26 03:32:29 +05:30
Eklavya Sharma
101148c49e
Fix typo and formatting in docs.
2016-04-25 20:29:29 +05:30
Tim Abbott
74ed9fabd0
Integration guide: Expand instructions on screenshots.
2016-04-21 18:17:26 -07:00
Tomasz Kolek
82f1cdb085
Add send_webhook_fixture_message command.
...
This tool simplifies the process of producing nice screenshots for
documenting webhook integrations.
Fixes #658 .
2016-04-20 10:45:27 -07:00
Tim Abbott
1b988de30a
Integration guide: clean up description of plugin integrations.
2016-04-19 16:21:33 -07:00
Tim Abbott
92f9a789b8
integration guide: Improve introduction.
2016-04-19 16:21:33 -07:00
Sumana Harihareswara
4ce4f88a03
Fix formatting in directory-structure.rst.
2016-04-13 15:44:10 -07:00
Tim Abbott
be96cf809d
Move Zulip backend tests to zerver.tests.
2016-04-11 22:16:09 -07:00
Tim Abbott
5c810ad0bc
Add new markdown documentation to ReadTheDocs.
2016-04-01 14:57:30 -07:00
Tim Abbott
52764763c6
Add some docs on schema migrations.
2016-04-01 09:57:00 -07:00
Tim Abbott
37b79deb60
Expand documentation on frontend build process.
2016-04-01 09:56:59 -07:00
Tim Abbott
7a671c2652
Add documentation on the Zulip RabbitMQ queues.
2016-04-01 09:56:59 -07:00
Tim Abbott
96eb81e5d5
Add documentation of Zulip's markdown implementation.
2016-04-01 09:56:59 -07:00
Tim Abbott
342b4eb457
Add a detailed integration writing guide.
...
Fixes : #70 .
2016-04-01 09:56:59 -07:00
Tim Abbott
b8c7cfb77e
docs: Add Javascript manual testing section.
2016-04-01 09:34:45 -07:00
Ryan Moore
2fe0700f55
Update memcache -> remote cache in inline documentation.
2016-03-31 12:56:42 -07:00
Tim Abbott
02ccb68f7e
code style: Document auto-closing GitHub issues.
2016-03-19 10:17:25 -07:00
Tim Abbott
ecc66d6eec
code style: Improve the commit message style documentation.
2016-03-19 10:09:21 -07:00
Anindya Chakravarti
d72b8b83f7
Fixed a typo in documentation.
2016-03-17 22:53:42 -07:00
Tim Abbott
408ff14be8
Fix parsing html_unescape.py in py3k test.
...
This file was using print as a function but didn't import
print_function; as a result futurize threw an error every time it
parsed this file.
2016-01-09 15:43:30 -08:00
Allie Jones
11c69fb0b2
Add documentation on the front end build process and webpack.
2015-11-20 20:32:01 -08:00
Tim Abbott
d06cb5d55a
Expand documentation on writing and debugging Casper tests.
2015-11-11 21:36:00 -08:00
Tim Abbott
10657c1d53
Move node tests to node_tests/.
2015-10-28 10:11:47 -07:00
Tim Abbott
f1074aa491
Move frontend tests out of zerver/tests/.
...
This fixes an unfortunate bug where the backend tests in
zerver/tests.py were not being run automatically, and also makes these
a bit easier to find.
2015-10-28 10:11:47 -07:00
Steven Oud
d5435fad1d
Consistently use /usr/bin/env python2.7 in shebangs and commands.
2015-10-21 22:58:21 +00:00
Allie Jones
99a2ba38b1
Expand new feature tutorial.
2015-10-15 09:12:22 -04:00
Tim Abbott
5bf6f05f60
Add readthedocs requirements.txt.
2015-09-25 10:53:47 -07:00
Tim Abbott
b21a105a99
Reorganize and delete obsolete content from testing.rst.
...
(imported from commit 1d62b50c0b01d5386c8a6ffbde745abb6d79ad6e)
2015-09-25 03:40:31 -07:00
Tim Abbott
827e7ad19c
docs: Cleanup new feature tutorial and note unfinished.
...
(imported from commit 668eabb53f746afe7455b0f5fd1e8f5741894c5e)
2015-09-22 22:38:55 -07:00
Tim Abbott
a3c122eb41
Remove largely obsolete documentation pages.
...
(imported from commit eb02c24dd25a12a5676b5e52c914993650f73aa6)
2015-09-22 22:37:45 -07:00
Tim Abbott
1be909a450
docs: Content editing for directory-structure.rst.
...
(imported from commit aa331a561f1e905c9453bd0590eb1147c19f2be4)
2015-09-22 22:17:56 -07:00
Tim Abbott
3c1c14a7cc
docs: Fixed a bunch of factual issues in coding style guidelines.
...
(imported from commit 6320d45ad064fcc5b3e8f01247b18af1a85bf91f)
2015-09-22 22:13:28 -07:00
Tim Abbott
b6e2fd6e83
Rename build-voyager-tarball to build-release-tarball and document.
...
(imported from commit 06f102f4f4c5caf187f4930fadff06147f095401)
2015-09-22 21:22:11 -07:00
Yoyo Zhou
ab5e04ef36
Add backend tests location
...
(imported from commit 2f2dcd1773be746bee5d9003ca99020230acae04)
2015-08-22 13:08:11 -07:00
Yoyo Zhou
e130884c6a
code-style: Simplify rST syntax.
...
(imported from commit c2bd43f97969b7be61476435ac00ae03fd05ec4d)
2015-08-22 13:08:07 -07:00
David Roe
c17e50e0c4
Add new feature tutorial.
...
(imported from commit 1577c2567232aba1a1f1c6d1df83370acf54af55)
2015-08-22 12:56:57 -07:00
David Roe
a9cf471239
Remove documentation on ALLOW_REGISTER since it is out of date.
...
(imported from commit 75938998507f2b903f49bd9c7c4ecc0eadb3259d)
2015-08-22 12:55:18 -07:00
David Roe
33b7b2d021
Add welcome.rst with info for new developers.
...
(imported from commit 14e27efc47cfb0802f16ec5d2d6c5eadeba7a2c2)
2015-08-22 12:54:20 -07:00
David Roe
1a3bc517d9
Improve docs/README.md
...
(imported from commit 78193958bdb5f92ae5d8706340a739dae0da5367)
2015-08-22 12:53:54 -07:00
David Roe
3f7cb34b00
enterprise => voyager
...
(imported from commit 04be792bb480d5e5db1c91d296d1000cf1682571)
2015-08-21 10:33:35 -07:00
David Roe
f79adf830f
deployed => production
...
(imported from commit 2d7b0a7a73b0c84b32634a88af1e0d666139d4ff)
2015-08-21 10:33:35 -07:00
Yoyo Zhou
f78abd2dcc
Update schema changes content and formatting.
...
(imported from commit 46f3d43bfe62883d490ea870b2d29f7a45397c08)
2015-08-20 14:24:59 -07:00
Yoyo Zhou
4a6e132a44
Add "Schema changes", rST generated via pandoc -r mediawiki -w rst
...
(imported from commit f3c5621a8b612217986c879d3d15b85c9098ccca)
2015-08-20 14:24:59 -07:00
Yoyo Zhou
1e3249c94e
Add note that provision.py sets up postgres test db for you
...
(imported from commit 87d31b04db15b8ea994f40362ab910ccc028c91a)
2015-08-20 14:21:55 -07:00
Yoyo Zhou
a1237aa2b2
Update testing notes formatting and content.
...
(imported from commit 44cc34888f14d101c29bcd1c8d63cc082b4ffe09)
2015-08-20 14:21:55 -07:00
Yoyo Zhou
bb45f8d8e3
Copy "Testing the app" from the wiki, via pandoc -r mediawiki -o rst
...
(imported from commit 7150179ff1008ffa6849b983fb579a36fffc9c06)
2015-08-20 14:21:55 -07:00
Yoyo Zhou
6e55b4df8a
Update directory-structure.rst content to fix internal references
...
- Delete references to zilencer
- Replace "local server" references
- Add directories for message views, frontend templates/tests, and docs
(imported from commit 7295835434c17609595399e3aec7f9d565fd6b3d)
2015-08-19 11:52:49 -07:00
Yoyo Zhou
1629e77174
Directory structure generated from pandoc, with formatting fixes
...
(imported from commit d54bb062b641bac0520494f0a2cb151d69018d61)
2015-08-19 11:52:49 -07:00
Yoyo Zhou
127cdf63c6
Add CSS style override for RTD to make tables use word wrapping
...
(imported from commit 29007c052dd7048eaf86388a6a9715fc13f102b5)
2015-08-19 11:52:49 -07:00
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
Yoyo Zhou
7b9e027e77
Expand the Lint section to replace the Python and JS subsections; remove obsolete comment from Secrets.
...
(imported from commit a6945617913700d4e18c398a68022ed90f56039e)
2015-08-18 20:17:47 -07:00
Yoyo Zhou
8461048a11
Add 'Code style', generated via pandoc -r mediawiki -w rst and html_unescape.py
...
With a basic README.md
(imported from commit 91728b2c591bc88b7bee520669cb0b3f53426cd8)
2015-08-18 17:34:02 -07:00
Yoyo Zhou
c25d9679a5
Utility for unescaping HTML entities leftover from MediaWiki->rST conversion
...
(imported from commit 2f2507f299c3d09c67bfd26d6c11fab47431d935)
2015-08-18 17:31:33 -07:00
Yoyo Zhou
16e462d9d2
Use sphinx_rtd_theme when not on ReadTheDocs
...
(imported from commit ba97a475f85251f694e4c88d1dd25eaf69078fc4)
2015-08-18 17:31:32 -07:00
Yoyo Zhou
ac63d942ce
Initial sphinx setup from sphinx-quickstart
...
(imported from commit b9fc7a8f2f9352129c104f5dc9305203f2efc63d)
2015-08-18 17:31:32 -07:00