Nicolas Braud-Santoni
34479f06f1
docs/developers: Encourage using rel_path in validate_manifest
2016-09-12 19:20:22 +02:00
Anders Ingemann
f62c8ade99
Convert indentation from tabs to spaces (4)
...
Up until now I didn't see the point of using spaces for indentation.
However, the previous commit (a18bec3) was quite eye opening.
Given that python is an indentation aware language, the amount of
mistakes that went unnoticed because tabs and spaces were used
at the same time (tabs for indentation and spaces for alignment)
were unacceptable.
E101,W191 have been re-enable in the tox flake8 checker and
the documentation has been modified accordingly.
The following files have been left as-is:
* bootstrapvz/common/assets/extlinux/extlinux.conf
* bootstrapvz/common/assets/init.d/expand-root
* bootstrapvz/common/assets/init.d/generate-ssh-hostkeys
* bootstrapvz/common/assets/init.d/squeeze/generate-ssh-hostkeys
* bootstrapvz/plugins/docker_daemon/assets/init.d/docker
* bootstrapvz/providers/ec2/assets/bin/growpart
* bootstrapvz/providers/ec2/assets/grub.d/40_custom
* bootstrapvz/providers/ec2/assets/init.d/ec2-get-credentials
* bootstrapvz/providers/ec2/assets/init.d/ec2-run-user-data
* docs/_static/taskoverview.coffee
* docs/_static/taskoverview.less
* tests/unit/subprocess.sh
2016-06-04 11:38:16 +02:00
Anders Ingemann
2d6a026160
Fix a slew of indentation & spacing issues
2016-06-04 11:38:16 +02:00
Tiago Ilieve
c6226f89ae
Fix a few typos
2016-04-13 04:38:42 -03:00
Anders Ingemann
6bb654b79f
Compat with new sphinx
...
Changed a lot of code:: to code-block::
Also added sphinx_rtd_theme to deps in tox
2016-03-04 01:21:52 +01:00
Anders Ingemann
f8118b3f3e
Rename integration tests to system tests, since they cover the entire system
...
*cough e82bdf4
2016-03-04 00:48:48 +01:00
Tiago Ilieve
b6bdc873f7
Add links to GitHub profiles on Supported Builds
2016-02-09 17:37:30 -02:00
Tiago Ilieve
790f2d66bb
Update supported builds
...
- Remove mentions to squeeze, as it isn't supported since yesterday[1]
- Add 'known working builds' section
This closes #266 .
[1]: https://www.debian.org/releases/squeeze/
2016-02-07 18:00:58 -02:00
Anders Ingemann
35121f9c7f
Add option to document integration test providers seperately
2015-12-13 19:42:15 +01:00
Anders Ingemann
7f936e9ad8
Fix link transformation regexes for manifest docs
...
Forgot to add them when introducing the official manifests structure
2015-07-23 08:41:51 +02:00
Anders Ingemann
b8b94c1fc7
Add some docs for the official manifests
2015-06-13 20:25:45 +02:00
Anders Ingemann
e556366c19
Fix #98 . External plugin architecture implemented
2015-05-03 13:07:26 +02:00
Anders Ingemann
84de1de00f
Docs for integration testing
2015-04-20 16:26:05 +02:00
Anders Ingemann
db3d2f191a
Fix links to tests/ READMEs
2015-04-19 19:23:50 +02:00
Anders Ingemann
b46858d9fc
Add documentation about the documentation
2015-04-19 14:41:21 +02:00
Anders Ingemann
3a1e3c7feb
Account for anchorlinks inside the same document
2015-04-19 14:37:50 +02:00
Anders Ingemann
8064cddb1d
Add README to docs
2015-04-19 13:45:31 +02:00
Anders Ingemann
b42b788a45
Rename replace_rtd_links to transform_github_links
...
since that's what's actually happening now
2015-04-19 13:29:10 +02:00
Anders Ingemann
501e6ad97b
This is cool. Relative links that link between folders/files in the github repo are converted to relative links in the documentation.
2015-04-19 13:05:58 +02:00
Anders Ingemann
e80ad46972
Repeat index/README pattern for plugins & providers
2015-04-16 23:52:07 +02:00
Anders Ingemann
7d0b9f5bc5
Flatten docs structure
2015-04-16 23:34:46 +02:00
Anders Ingemann
a7d5c93fa1
Add README for remote bootstrapping
2015-04-16 23:32:19 +02:00
Anders Ingemann
01f5a2db04
Add structure for testing docs
2015-04-16 23:30:41 +02:00
Anders Ingemann
03f8d231e2
Move developers intro into bootstrapvz/ as README
2015-04-16 23:27:09 +02:00
Anders Ingemann
e3f511f8e8
Fix inclusion of main README by using "self" in toctree
2015-04-16 23:15:28 +02:00
Anders Ingemann
61dc50ae23
Add list of supported builds
2015-04-16 23:04:02 +02:00
Anders Ingemann
2f3ee404d1
Remove bogus intro text from providers/index.rst
2015-04-12 15:42:43 +02:00
Anders Ingemann
188672404b
Move developer doc stuff into developers/ subfolder
2015-04-12 15:12:37 +02:00
Anders Ingemann
6980dd6517
Add sphinx extension that replaces absolut RTD urls
...
This makes it possible to add proper links when showing an rst on github,
while also resolving it to relative links on readthedocs
2015-04-12 14:33:04 +02:00
Anders Ingemann
62b87f22d5
Link to code in github rather than embedding it
2015-04-12 14:33:03 +02:00
Anders Ingemann
f27d622e2c
Include changelog in docs (converted it to rst)
2015-04-11 17:12:31 +02:00
Anders Ingemann
619fed5275
Merge dev guidelines and contribution info into single doc
2015-04-11 17:04:09 +02:00
Anders Ingemann
79ba557777
Convert README.md into rst and include from the docs
2015-04-11 16:58:49 +02:00
Anders Ingemann
34a87acf16
Add documentation about the manifest
2015-04-11 16:43:01 +02:00
Anders Ingemann
c089301f79
Generate task graph data through sphinx conf.py
2015-04-11 16:40:44 +02:00
Anders Ingemann
fc29266c97
Move API docs into api/
2015-04-11 16:40:44 +02:00
Anders Ingemann
953987fddf
Combine documentation from github wiki with sphinx
...
This is the first step in the effort of combining all documentation about
bootstrap-vz into sphinx while still being able to access it from github
(github can parse rst as well)
2015-04-11 16:40:44 +02:00
Anders Ingemann
73972e1b60
Move taskoverview exec into docs/
2015-04-11 16:40:44 +02:00
Anders Ingemann
d06fbb4a2d
Turn on nazi option for sphinx and fix warnings
2015-04-11 16:40:44 +02:00
Anders Ingemann
be5590f411
Add highlighting of tasks in same module in taskoverview
...
and a docs-serve tox target
2015-04-11 16:40:43 +02:00
Anders Ingemann
0276b70910
Fix taskoverview graph
2015-04-11 16:40:43 +02:00
Anders Ingemann
d3f306a6d9
Build docs through tox
2015-04-11 16:40:43 +02:00
Razvan Musaloiu-E.
091030affd
Fix a typo: s/topoligcally/topologically/
2014-06-26 07:05:46 -07:00
Anders Ingemann
6c071bed72
Update syntax check command
2014-05-10 20:34:25 +02:00
Anders Ingemann
02c683120a
Refactor tasklist for easier integration by taskoverview
2014-05-10 17:28:31 +02:00
Anders Ingemann
f0e5be0ded
Split up development page
2014-05-10 16:56:26 +02:00
Anders Ingemann
f86e15aa49
Move taskoverview into docs/
2014-05-10 16:42:35 +02:00
Anders Ingemann
de76c3aadd
Move development guidelines into docs
2014-05-10 16:22:32 +02:00
Anders Ingemann
ee6df57f3f
Use RTD theme
2014-05-04 19:11:33 +02:00
Anders Ingemann
69a76f2597
Fix PEP8 errors
2014-04-10 00:27:37 +02:00
