Commit graph

26 commits

Author SHA1 Message Date
Sandra McCann
409545825f docs: update to latest 3 versions (#64109) 2019-10-31 19:32:05 -05:00
Sandra McCann
92d57796dd Update Ansible sphinx theme to rtd theme version 0.4.3 (#61189)
* update theme.conf, header, footer, etc.
* clean up layout.html
* move large Ansible changes out of theme.css
* maxify theme to help merge
* remove redundancies, fix top nav bar
* add Ansible color to header and left-nav menu
2019-08-28 10:47:11 -05:00
Toshio Kuratomi
b0ec91e69e Autointerpreter table (#60148)
* Some framework for docs

* Separate CSS file for our site-specific CSS.
* Override the read-the-docs theme for tables so that tables don't
  always horizontally scroll
* Add a |br| substitution that lets us line break inside of tables
* Add |_| non-breaking-space substitution which is also for formatting
  tables
* Configure rstcheck to ignore all substitutions which are being added
  by sphinx in the conf.py

* Fix table of auto interpreter options

The table was being hardcoded at a certain width to work around a
read-the-docs theme bug.  Fix the bug instead and format the table using
better sphinx practices.

* Remove unused substitutions

We had substitutions defined that were never used in our documentation.
Remove those.

Also add to the rstcheck whitelist three substitutions which are defined
by sphinx itself, version, release, and today.
2019-08-08 13:56:07 -05:00
Sandra McCann
35b6345bdc Add a banner message to warn when not on latest documentation (#58526)
* add banner to versions that are not latest

* move div into script

* fix div

* move comment

* fix shippable errors
2019-06-28 15:06:49 -05:00
Sandra McCann
f3720c90e0 [WIP] Add dropdown version selection to docsite (#55655)
* docs: Add way to select version for documentation
2019-06-19 14:39:45 -05:00
Alicia Cozine
5658b2ee3e
Adds custom 404 with cowsay image (#57422)
* Adds custom 404 with image, updates CI reqs, sets version latest for TOC links on 404 page
2019-06-17 10:47:54 -05:00
Sandra McCann
3136007032 update docsite breadcrumbs from sphinx_rtd_theme (#57316)
* improve breadcrumbs
* get edit on github working again
2019-06-05 14:26:34 -05:00
Sandra McCann
4bf134756b changed version to 2.8 (#56487) 2019-05-15 14:59:21 -05:00
Sandra McCann
47a440774f Speed up the Sphinx documentation build (#55593)
* speeds up the docs build by changing the navigation collapse setting
2019-04-29 15:34:02 -05:00
Andreas Krüger
18bf48cec2 Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416) 2018-12-10 09:17:15 -06:00
Xaroth
59e7a9442e -Change: set the 'canonical_url' theme option to enable rendering of canonical urls, promoting the 'latest' docs to search engines. (#49190) 2018-11-27 10:35:50 -06:00
Alicia Cozine
ba9348883b
updates latest in docs conf.py (#46400) 2018-10-03 21:56:11 -05:00
John R Barker
da59a8a678 Use updated pygments (#44846)
Before this PR we were not using _static/ now we do
Remove all old files so we don't replace 2018 versions with 2011
2018-08-29 11:51:40 -05:00
Lucid One
4c62722675 Fixed opensearch double slash issue (#44137)
http://www.sphinx-doc.org/en/stable/config.html#confval-html_use_opensearch
"(without trailing slash)"
2018-08-16 16:28:58 -05:00
Felix Fontein
e7e63ec1e8 Improving syntax highlighting in HTML docs (#42472)
* Adding improved YAML lexer for HTML docs.

* Fixing (some of) the warnings.

* Fixing more warnings.

* Removing ansible- prefix from lexer names.

* Rename extensions -> _extensions.

* Removing superfluous module search path extension.
2018-07-31 15:28:16 -05:00
Lucid One
40fcef3e41 Adding support for opensearch of documentation (#38593) 2018-04-25 18:01:26 -07:00
Sam Doran
34dca85417 Update installation docs for RHEL based distributions. (#38056)
Upstream rpms are no longer in Extras but EPEL as well as releases.ansible.com.
Add instructions for adding Ansible Engine repo to RHEL.
2018-04-05 10:46:46 -07:00
scottb
373b1dcf59
Core Docs Refactor and Redesign (#36067)
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
2018-02-13 07:23:55 -08:00
Toshio Kuratomi
40ea448c7b Misc docs fixes
* Revise and link inline to the lists of modules

* Fix jinja2 objects.inv fallback path

* Fix bolding of deprecation marker

* Change module_support to link to lists via :doc:
  That links to the top of the page instead of a section.

* Add a short text for each list of maintained modules
* Change maintenance info to only display on core and network modules
2017-08-22 11:52:30 -07:00
Toshio Kuratomi
fe2e17f7cd Update the intersphinx cached indexes
In case we build docs offline, we want to have a cached copy of the
documentation refs that are in the intersphinx docs we reference.
Update those to the lattest versions from their respective upstreams
2017-08-14 08:15:28 -07:00
Dag Wieers
47738eb1dd docs: PEP8 compliance (#24681)
- Make PEP8 compliant
2017-05-30 18:08:25 +01:00
Toshio Kuratomi
78dd3496e2 Update version and change remove files from pep8 blacklist 2017-04-25 12:26:40 -07:00
Toshio Kuratomi
4c7a2e2622 Enable intersphinx for python stdlib and jinja2
This setting allows us to reference jinja2 and python stdlib docs
via docutils refs instead of hardcoding urls.

Fixes #18039

Remove extraneous sphinx config
2017-04-25 12:26:40 -07:00
Matt Clay
10d9318de7 PEP 8 indent cleanup. (#20800)
* PEP 8 E121 cleanup.

* PEP 8 E126 cleanup.

* PEP 8 E122 cleanup.
2017-01-29 07:28:53 +00:00
Matt Clay
d913f69ba1 PEP 8 W291 whitespace cleanup. 2017-01-27 17:08:02 -08:00
Adrian Likins
3645893a5b update path to _themes 2017-01-13 18:14:33 -05:00