Seth House
2c659f033b
Remove RTD check for theme selection
2014-04-16 23:58:58 -06:00
Colton Myers
f366db8816
Update doc version to 2014.1.3
2014-04-16 13:57:03 -06:00
Seth House
bcb66f160f
Add Sphinx extension to generate an index for short-URLs
2014-04-15 18:01:31 -06:00
Seth House
ca028dae3c
Add docs for the saltnado netapi module
2014-04-14 22:53:17 -06:00
Seth House
bc10b02d21
Mock requests for building the docs
2014-04-11 14:22:12 -06:00
Seth House
41557bf2be
Remove special mocking for uppercase names
...
I'm not sure what this was supposed to do. But it causes the occasional
problem when mocking things that have no business being capitalized but
are anyway.
2014-03-27 20:04:49 -06:00
Colton Myers
ae8db02e5e
Update released version to 2014.1.1
2014-03-25 10:14:59 -06:00
Seth House
00681d86a4
Updated the Latex docs to build with the latest logo
2014-03-21 13:51:53 -06:00
Seth House
6e1bb4bdf0
Remove unused html_logo setting
2014-03-21 13:51:53 -06:00
Seth House
e1ea6dd89b
Mocked cherrypy.lib for building the docs
2014-03-10 19:50:39 -06:00
Seth House
6d0b0f24c0
Added opensearch configuration to the docs conf.py
2014-03-01 22:29:09 -07:00
Mike Place
2f5c1563df
Fix GCE build errors.
2014-02-26 13:32:33 -07:00
Seth House
d0dc53b54d
Added missing .0 to end of the verion in the docs conf
2014-02-22 20:27:44 -06:00
Mike Place
a485eceac9
Fix all broken links in docs. Ignore certain known-good links. Adjust many links that are returning 301.
...
Conflicts:
doc/topics/installation/index.rst
2014-02-20 16:16:59 -07:00
Colton Myers
f7bded078d
Wait until actual announced release to change doc version
2014-02-19 13:32:45 -07:00
Colton Myers
b3e22bdec5
Update bug fix release notes and update doc version
...
Conflicts:
doc/conf.py
2014-02-19 13:29:55 -07:00
Seth House
568ece37ea
Mocked salt.utils.event for building the docs
2014-01-30 11:59:47 -07:00
Colton Myers
3f8799a334
Update current release in docs
2014-01-27 10:00:26 -07:00
Seth House
fd099aaa50
Removed old/unused rST substitution
2014-01-02 15:40:57 -07:00
Seth House
9f7fab6df0
Moved LiterateCoding directives into Salt domain
2013-12-23 06:02:12 -07:00
Seth House
f2ad5b1bef
Remove sidebars for formula docs
2013-12-23 06:02:11 -07:00
Seth House
5f8df81d37
Added first stab at a literate-code style documentation directive
2013-12-23 06:02:11 -07:00
Seth House
cb8ed95992
Moved custom conf cross-references into Salt domain file
2013-12-13 22:45:48 -07:00
Seth House
c0f74f95aa
Added minor Salt Sphinx domain
2013-12-13 22:45:48 -07:00
Colton Myers
2ea3e3fed2
Add 0.17.4 release notes
2013-12-09 14:47:25 -07:00
Mike Place
e3f6027773
Update doc build to use latest GH release system.
...
It looks like GH has deprecated the download system that we were using. This fix just updates our doc build to point to the new system. Here's the blog post for reference:
https://github.com/blog/1302-goodbye-uploads
This resolves many errors that appear when running 'make linkcheck' against our docs.
2013-12-09 10:51:02 -07:00
Mathieu Le Marec - Pasquet
5f46962e80
pep8 fixes
2013-12-04 00:25:50 +00:00
Colton Myers
c8853784e9
Bump docs version to 0.17.2
2013-11-12 14:09:36 -07:00
Seth House
8807eea450
Added directory for clouds modules documentation
2013-11-11 16:25:28 -07:00
Erik Johnson
8f7ac73100
Mock yaml.scanner in docs conf.py
2013-11-10 15:39:27 -06:00
Seth House
7b9ebf9872
Absorbed Sphinx conf.py for salt-cloud into Salt's
2013-11-08 15:08:32 -07:00
mekstrem
c35fb3dfee
Update conf.py
...
Fixed typo.
2013-10-29 09:13:07 +01:00
Erik Johnson
db3768d00a
Bump version to 0.17.1
2013-10-17 13:04:01 -05:00
Pedro Algarvio
99bcf207d0
Properly render aliased salt function names. Fixes #7885 .
2013-10-16 22:52:56 +01:00
Pedro Algarvio
3cd0ac8642
Add support for other documentation languages.
2013-10-11 23:23:17 +01:00
Seth House
3a22b3af38
Removed special case for uppercase attributes from Mock object
...
I'm not sure what the original intent of this behavior was but we don't
appear to be using it and it breaks the infinite chain-ability of the
Mock() object by not returning a chain-able object. E.g.:
``Mock().thing.thing.thing...`` works but ``Mock().thing.Thing.thing``
breaks.
Fixes #7725 .
2013-10-10 23:57:19 -04:00
Erik Johnson
5a31008fd4
Update version number in docs to 0.17.0
2013-10-08 16:18:08 -05:00
Seth House
93834f5b4c
Stole the youtube directive from sphinx-contrib
2013-09-17 17:56:56 -06:00
Erik Johnson
6f96971c94
Update "current release" link to 0.16.4
2013-09-12 17:10:45 -05:00
Seth House
4e0f523ede
Added configuration entries to allow translating Salt docs
2013-09-11 22:23:46 -06:00
Pedro Algarvio
105a81ac27
Revert "Renamed gentoolkitmod
module gentoolkit
while enforcing absolute imports."
...
This reverts commit 0f08e6088b
.
2013-08-20 23:43:54 +01:00
Pedro Algarvio
6659f0393f
Revert "Renamed ldapmod
module to ldap
while enforcing absolute imports."
...
This reverts commit c4c58370d2
.
2013-08-20 23:43:52 +01:00
Pedro Algarvio
580a666f60
Revert "Renamed localemod
module to locale
while enforcing absolute imports."
...
This reverts commit 791dc53ca6
.
2013-08-20 23:43:50 +01:00
Pedro Algarvio
39b87cecfb
Revert "Fixed documentation linking."
...
This reverts commit 758e789d12
.
2013-08-20 23:43:48 +01:00
Pedro Algarvio
758e789d12
Fixed documentation linking.
2013-08-19 17:40:07 +01:00
Pedro Algarvio
791dc53ca6
Renamed localemod
module to locale
while enforcing absolute imports.
2013-08-19 17:01:42 +01:00
Pedro Algarvio
c4c58370d2
Renamed ldapmod
module to ldap
while enforcing absolute imports.
2013-08-19 16:31:27 +01:00
Pedro Algarvio
0f08e6088b
Renamed gentoolkitmod
module gentoolkit
while enforcing absolute imports.
2013-08-19 16:24:01 +01:00
Erik Johnson
fc2ec7d3f5
Fix current release in docs
2013-08-12 13:50:46 -05:00
Pedro Algarvio
84e16b3034
Add salt-ssh to man pages.
2013-08-10 16:03:07 +01:00
Pedro Algarvio
9f47a1a0ad
CLI Output options now reside on it's own, common, document.
2013-08-10 15:37:33 +01:00
Seth House
db37dbc02c
Added saltstack-formulas GitHub organization to extlinks config
...
This allows making quick links to formula repositories such as:
The fastest way to install EPEL is including the
:formula:`epel-formula`.
2013-08-07 14:34:47 -06:00
Pedro Algarvio
e7be91fc87
Enable linking directly to python's documentation.
2013-07-23 16:39:55 +01:00
Pedro Algarvio
de80f557d8
Add OpenSSL
and zfs
to the mocked modules in the docs.
2013-07-22 13:09:07 +01:00
Seth House
988b2e50e5
Added the current Salt release to the sidebar
2013-07-15 15:10:34 -06:00
Seth House
4b09672b93
Changed copyright name to the company name
2013-07-15 15:10:34 -06:00
Seth House
74fb3c514f
Pull latest release version into the docs conf
2013-07-15 15:10:34 -06:00
Seth House
e94a47ed6c
Add html_default_sidebars to context dict
...
Omitted from f300e75
.
2013-02-28 10:45:03 -07:00
Seth House
f300e75afe
Restored html_default_sidebars setting; added JS TOC to modules sidebar
...
Using JavaScript to generate a local table of contents for the modules
is less than ideal but this isn't easily accomplished with autosummary
(see 87c1000
) and we badly need this.
2013-02-28 10:14:14 -07:00
Seth House
19222e3e6c
Switch to Sphinx-default sidebars
2013-02-26 15:18:31 -07:00
Seth House
57902fa267
Updated docs with new design
2013-02-26 12:22:03 -07:00
Seth House
259c8848b6
Restored saltstack theme
2013-02-26 12:22:03 -07:00
Seth House
dc737520b9
Moved document fragments into excluded directory
...
This avoids "document isn't included in any toctree" warnings.
2013-01-24 00:06:02 -07:00
Baiju Muthukadan
b9338e48fb
use new logo
2013-01-22 16:54:09 +05:30
Thomas S Hatch
d8bfff58d8
It is 2013 now
2013-01-15 20:46:43 -07:00
Seth House
10616f5198
Mocked YAML
2013-01-11 09:36:09 -07:00
Seth House
fd0ff68683
Fixed config for man/latex output
2012-11-17 09:36:46 -07:00
Seth House
73d1e0bb6e
Mocked a bunch of libs
2012-11-15 15:16:41 -07:00
Seth House
f48a0d9da5
Mocked rabbitmq_server
2012-10-25 14:36:02 -06:00
Seth House
63ccd4f77e
Mocked several modules in order to build the docs
2012-10-24 16:32:53 -06:00
Seth House
0ba1ae8c9e
Copied (and modifed) conf.py from Salt
2012-10-16 16:57:55 -06:00
Seth House
5330026341
Tweak conf.py for moar quieter pylint
2012-10-15 14:26:11 -06:00
Seth House
2c76365894
Re-added the index to the built docs
2012-10-11 14:40:40 -06:00
Seth House
5e5a51c49c
Sorted mocked modules list for better readin'
2012-10-04 18:52:51 -06:00
Seth House
21b35b498a
Added django to mocked modules for building documentation
2012-10-04 18:52:50 -06:00
Thomas S Hatch
bcc1dbbca8
Add the doc tree for salt-api
2012-09-24 14:17:56 -06:00
Seth House
f9efcffbf4
Missed the hidden 'v' in last commit
2012-09-24 12:20:17 -07:00
Seth House
b1ecedfc28
Point links to Github blobs to 'develop' instead of releases
2012-09-24 12:16:12 -07:00
Brian Riley
a3c456f8cd
Fix for bad installation link
...
The tutorials had a link to a non-existant installation page. I changed
this to link to the installation index document. I also removed the
unused installtion link from `conf.py`.
2012-07-16 15:55:23 -07:00
Thomas S Hatch
b4ae7d97a0
fix email
2012-07-13 09:38:59 -06:00
Baiju Muthukadan
8223969b0f
Fix the order of release notes listing
2012-06-19 14:21:27 +05:30
Seth House
d389f162da
Fixed including functions beginning with underscores in autodoc output
2012-06-10 08:55:13 -07:00
L.C. Rees
cc8a921311
- more py3k fixes
2012-06-04 16:40:34 -06:00
Dan Colish
a3507abe49
Skip mod_init when running autodoc, #1282
2012-05-29 16:17:03 -07:00
Seth House
b1bc8ff503
Added mock object for M2Crypto when building the docs
2012-04-25 23:09:48 -06:00
Monty Taylor
3867ffb3ef
Replace M2Crypto RSA with PyCrypto.
...
M2Crypto has been abandonded upstream, has many outstanding bugs,
and doesn't build unpatched on Fedora. Since the only thing M2Crypto
is being used for in the salt codebase is RSA support, using the PyCrypto
RSA module instead is pretty straight forward. Additionally, the RSA
module uses sign/verify terminology around our use of private encrypting
known tokens for verification purposes rather than private_encrypt and
public_descrypt, which makes reading the intent a little clearer.
2012-04-20 09:30:33 -07:00
Seth House
84b5b5ba49
Added a couple yaml mock objects for RTD
2012-03-19 05:43:10 -06:00
Seth House
c03716e470
Revert "Playing with RTD tweak to use Sphinx default theme"
...
This reverts commit c5af26f31a
.
2012-02-18 10:43:59 -07:00
Seth House
c5af26f31a
Playing with RTD tweak to use Sphinx default theme
2012-02-18 10:40:50 -07:00
Bret Palsson
f66738e934
Update copyright date
2012-02-10 10:20:45 -07:00
Seth House
4514368865
Removed site homepage; replaced with docs homepage
2012-02-08 03:20:41 -07:00
Seth House
f7dce9a7ee
Replaced links to installation instructions
2012-02-08 03:20:41 -07:00
Seth House
45da8b9578
Removed custom Sphinx theme
...
Preparing to move all docs to RTD.
2012-02-08 03:20:41 -07:00
Thomas S Hatch
26b0215a2b
Add msgpack top Mock modules
2012-01-20 20:36:16 -07:00
Seth House
4e3aacc813
Slight modifications to docs in preparation for rtfd.org
...
Moved the html customizations into a proper theme and cleaned up the
configs to be useful for the default theme.
2012-01-16 02:46:41 -07:00
Seth House
105ed6d70c
Added pyyaml to the list of mocked imports for the docs
2012-01-16 01:45:30 -07:00
Seth House
b54d4ee573
Added new modules, states, returners docs
2012-01-15 22:54:23 -07:00
Seth House
31354bf15b
Mock various imports req'd for autodoc
2012-01-15 22:38:34 -07:00
Seth House
4edf6da1ed
Put local Salt directory at the front of PYTHONPATH
...
Sphinx's autodoc was seeing the globally installed Salt over the local
copy.
2012-01-10 06:10:34 -07:00
Seth House
08ed1da4cb
Added a custom 404 page for GitHub pages
2011-11-16 19:52:51 -07:00
Seth House
b6ecb49828
Updated URLs for the switch to the saltstack GitHub organization
2011-11-15 23:45:51 -07:00
Seth House
ebf5ce6474
Define sidebars only in conf.py; removed others
2011-11-13 04:53:40 -07:00
Seth House
0639489083
Replace manual & monolithic automodule with individual autosummary
2011-11-13 03:25:34 -07:00
Seth House
871e56007f
Fixed file mode; not sure how I marked these as +x
2011-11-06 22:47:36 -07:00
Seth House
692a0d7ef4
Added ePUB output configuration
2011-11-06 19:47:48 -07:00
Seth House
6fd90568fe
Renamed the contents / toc files to be a bit more logical
2011-11-06 19:47:48 -07:00
Seth House
22997def69
Added real logo and favicon
2011-10-16 23:54:11 -06:00
Seth House
b60e53e529
Added a real homepage; still in need of real content
...
Shamelessly ripping off the Sphinx project layout here...
2011-10-16 00:51:20 -06:00
Seth House
7458f69ac7
Stripped down the Sphinx config file
2011-10-16 00:51:20 -06:00
Thomas S Hatch
1c405cc902
Merge pull request #143 from whiteinge/version-import
...
Moved the version string to the Salt module
2011-09-25 07:46:09 -07:00
Seth House
a336f6c15f
Added shortcuts to hyperlink downloads, source files, and issues
2011-09-25 01:23:16 -06:00
Seth House
7050f09926
Replaced links to the download tarball with a substitution
2011-09-25 01:23:16 -06:00
Seth House
02a3dab489
Moved the version string to the Salt module
...
This move will allow fetching the verison from multiple places such as
setup.py as well as the docs.
2011-09-25 00:30:36 -06:00
Thomas S Hatch
62575c03ec
bump to 0.9.2
2011-09-17 12:51:17 -06:00
Thomas S Hatch
b956e7f7df
bump version to 0.9.1
2011-08-29 18:45:20 -06:00
Thomas S Hatch
4f6182d804
Add salt-call manpage tot he sphinx build
2011-08-27 11:36:12 -06:00
Thomas S Hatch
3ca9c2ba1f
Add syndic manpage ref to config
2011-08-27 11:30:32 -06:00
Thomas S Hatch
95c0866cb7
update sphinx to 0.9.0
2011-08-27 11:15:15 -06:00
Erik Nolte
1d71c9ce19
Move remaining salt-monitor code to the salt-monitor project
2011-08-10 13:54:38 -06:00
Erik Nolte
8918f26a14
Add salt-monitor documentation
2011-07-27 17:54:36 -06:00
Thomas S Hatch
9c39382613
Update shpinx conf to 0.8.9
2011-07-09 17:05:38 -06:00
Thomas S Hatch
6944b783ad
Move around the index to look better as a homepage, changed default
...
theme to agogo
2011-06-26 16:04:52 -06:00
Thomas S Hatch
ed68147885
Add an S to Thomas S. Hatch
2011-05-30 16:31:18 -06:00
Thomas S Hatch
e0143dc342
Merge the rendered spinx man pages into the deployment dir
2011-05-30 16:24:23 -06:00
Seth House
20f18681bd
Added initial Sphinx documentation
...
This commit moves the existing wiki pages on Github into rST with only
minor edits, formatting, and hyperlinking.
2011-05-27 06:27:42 +08:00