Commit Graph

23 Commits

Author SHA1 Message Date
Ross Patterson
2268293107 test(vcs): Reconcile devel docs from PR #798 2020-09-30 07:37:52 -07:00
Ross Patterson
93ee0b92d2 docs(test): Document how to install the VCS hooks
Move the VCS hook installation to a dedicated target to emphasize that it's opt-in.
Document why one might use the hooks and document how to install them.
2020-09-27 09:46:51 -07:00
meejah
8f983cb160 bump version to 1.14.0 and update release notes 2020-03-11 17:38:03 -06:00
Jean-Paul Calderone
739df66c80 can't have nice things 2019-08-14 14:48:12 -04:00
Jean-Paul Calderone
7511d605e8 Document the use of extras at install time 2019-08-14 09:27:48 -04:00
meejah
c2bf5e9074 add some notes about libssl version 2019-06-24 12:25:58 -06:00
meejah
fb9317ed80 change versions in INSTALL 2018-05-18 14:41:48 -06:00
Brian Warner
bc34556e1a INSTALL.rst: reorder deps 2017-06-06 10:26:11 +01:00
ValdikSS
718835e08c Update INSTALL.rst 2017-06-06 10:25:21 +01:00
tpltnt
2af8e69750 OpenSolaris is discontinued, naming illumos 2017-06-05 10:35:37 +01:00
Brian Warner
ce47f6aaee NEWS/INSTALL/relnotes: release 1.12.1 2017-01-18 16:28:23 -08:00
Brian Warner
120ef7ee86 docs/INSTALL: update pointers for 1.12.0 2016-12-17 14:36:18 -08:00
Brian Warner
91047bf828 docs: clean up .rst and references
This uses Read-The-Docs (sphinx/docutils) references exclusively, but adds a
README.md for GitHub viewers to remind them that the links there won't
work (closes ticket:2835).

It also fixes all the dangling references and other Sphinx warnings.

The "Preparation" section of docs/magic-folder-howto.rst was removed, since
this feature has since been merged to trunk.
2016-12-12 13:57:28 -08:00
Daira Hopwood
02362ae52c github does not render :doc: links; make sure that the links work there.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-15 15:38:52 +01:00
Brian Warner
23f871a409 add [test] "extra" to install testing-only dependencies
closes ticket:2776
2016-04-12 12:32:46 -07:00
Brian Warner
1199a1547f INSTALL: update downloads URL to expected location 2016-03-30 02:51:49 -07:00
Brian Warner
f81900ee35 format docs for Sphinx
Added indexes, fixed cross-references.

Also a few pip-related cleanups I noticed along the way.
2016-03-30 01:26:47 -07:00
Brian Warner
2cfe2eb566 INSTALL.rst: more tweaks 2016-03-29 21:01:22 -07:00
Brian Warner
20787853dd docs: stop suggesting 'activate', too much to explain
Also it avoids the failure mode where a user forgets to activate the
virtualenv, types the recommended "pip install" command, and installs
stuff directly to their system instead of safely confined inside the
virtualenv.
2016-03-26 14:13:23 -07:00
Brian Warner
365977bf51 minor docs tweaks
* use correct fixed-width-font markup
* fix hyperlinks to neighboring (github-side) .rst files
* refer to python-2.7.11 consistently (thanks to PRab for the catch)
2016-03-26 11:50:44 -07:00
Brian Warner
a63263dc55 minor docs tweaks 2016-03-25 19:25:55 -07:00
Brian Warner
ef1759046d rewrite docs, with pip and virtualenv 2016-03-25 19:22:03 -07:00
Brian Warner
090b592ff8 docs: rename quickstart to INSTALL 2016-03-25 18:26:54 -07:00