Commit graph

55 commits

Author SHA1 Message Date
Sandra McCann
0d379d4205
Explain module docs loss for devel (#68369) 2020-03-25 13:55:05 -05:00
Abhijeet Kasurde
2728c2476e
docs: Fixed "Edit on GitHub" link for plugin, cli (#66745)
Fixed sphinx theme to navigate "Edit on Github" link to locate correct
plugin, cli source in GitHub repo.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2020-01-30 10:55:46 -05:00
Sandra McCann
1a0724fdd4 Trim down to one Ansible search option (#66284)
* move swiftype search to upper left of docsite, fix spacing and length issues for search icon and searchbox
2020-01-10 16:31:46 -06:00
Toshio Kuratomi
365820f871 Add a banner which will display on the testing site. (#64763)
* Add a banner which will display on the testing site.

Thanks to shane for the javascript code

* change to more noticable color

Co-authored-by: Sandra McCann <samccann@redhat.com>
2019-12-23 12:15:47 -05:00
Sandra McCann
96cbbdd59f update version metadata to get faceted swiftype search running (#65574)
* update version metadata to get faceted swiftype search running
2019-12-05 15:16:34 -06:00
Sandra McCann
de826b437d Minify theme (#61734)
* moved most ansible edits out of theme.css
* remove unnecessary edit to theme.css
* replace with upstream minified theme.css for 0.4.3
2019-09-04 10:45:16 -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
Sandra McCann
00699735e9 add eol banner (#59254) 2019-07-18 14:15:43 -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
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
f9b43a0f68 Copyright fix for 2018 (#56860)
* update copyright in footer

* remove extraneous copyright from cli commands
2019-05-23 13:10:22 -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
Faisal Shaikh
0330ea616e Removed misleading padding from highlighted results of a search query (#55464) 2019-04-18 11:26:10 -05:00
Xaroth
646a8586a5 Remove old 'srtd' theme and references. (#49289) 2019-03-05 12:22:17 -06:00
Bianca Henderson
51ac4d3441 Update Ansible docsite CSS to fix multi-page printing issue (#51472)
* Update css to fix multi-page printing issue

* Add margin edit
2019-01-31 18:36:38 -06:00
Dag Wieers
49afb3da34 Update Docsite edit (#51115)
* Improved template for docsite edits
2019-01-29 14:28:16 -05:00
Dag Wieers
4fc6ab55aa This fixes a weird indentation issue in the menu (#45089) 2018-10-16 12:00:43 -05:00
Matt Clay
c3a6737004 Add BOM check to shebang sanity test.
Includes fixes for docsite files with a UTF-8 BOM.
2018-10-15 12:03:58 -07:00
Andreas Olsson
1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
2018-08-01 08:20:40 -07:00
Brian Campbell
fa5c0282a4 Use colspan on td instead of divs for hierarchical tables (#39948)
Address Firefox table-rendering issues in docs. Refactor to use colspan to provide table cells which can vary in width and indentation; the outermost has the greatest colspan, and each nested key has a colspan of one less than the parent, with padding cells for indentation.
Apply styling to table cells to get the table height to work without hacks or browser-specific
styling.  Simplify the markup and CSS by removing extra divs. Use two passes over the options, return values, and return facts in the Jinja2 module-docs template: one to determine the maximum nesting depth to compute the maximum colspan needed, plus one to lay out the rows.
2018-05-31 12:58:33 -05:00
scottb
d1d15dd025
Mobile CSS update - adds scrolling inertia (#38443) 2018-04-07 16:37:54 -07:00
scottb
785964ea97
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) 2018-04-06 20:34:31 -07:00
scottb
2381d2207e
Additional docs CSS fix for mobile (#38376) 2018-04-05 23:59:18 -07:00
scottb
79c5a34b0b
Fixes CSS so docs display properly on mobile (#38373) 2018-04-05 23:20:24 -07:00
Dag Wieers
cdf9e39647 Fix the automatic docsite_pr label (#37999) 2018-04-05 10:48:37 -07:00
scottb
68f81a6799
Reinstated element to fix doc display on mobile devices. (#38246) 2018-04-03 17:13:29 -07:00
scottb
3554e2c2d9
Fixes scrolling issue without breaking header nav (#37864) 2018-03-23 17:55:29 -07:00
scottb
47318a50b2
Temporary fix for horizontal scrolling issues on certain pages. Note that this will revert the behavior where headings scroll off the top of the main content region during navigation; fix for that is being investigated. (#37863) 2018-03-23 17:36:56 -07:00
scottb
0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. (#37548) 2018-03-16 21:35:41 -07:00
Dag Wieers
eb52a88fb6 Improve module docs return values (#36943)
* Improve module docs return values

Currently the 5 columns shown doesn't make optimal use of the screen
estate, especially for facts modules this is a problem.

* Add returned facts as a separate section

* Remove whitespace and add support section

Since Notes were moved higher up, the Author, Status and Maintainer
information was now placed under the Return Values section.

* Switch Last Updated and Copyright
2018-03-06 10:46:19 +00:00
Dag Wieers
bcdaba57b5 Remove Sphinx/Read-the-Docs plug on every doc page (#37023)
* Remove Sphinx/Read-the-Docs plug on every doc page

No need to have this on every page.

This fixes #37021

* Reinstated RTD credit with revised wording.

* Re-removed RTD footer boilerplate.
2018-03-05 16:14:27 -08:00
Dag Wieers
eae0aa0592 Automatically stuff reference in commit message (#36844)
* Automatically stuff reference in commit message

So we probably want to track which edits were performed through the
Github interface, and this change automatically adds a label to the
commit message.

```yaml
<!--- Your description here -->

+label: docsite_pr
```

Eventually this allows to (on regular basis) list the changes from
documentation readers and process them in a separate process.
2018-02-28 21:14:57 +00:00
Wolfgang Felbermeier
9c81b5d92b Fix table display width. (#36728) 2018-02-26 14:24:34 -08:00
Dag Wieers
e520ff2e99
docsite: Improve previous fix for smartphone/tablet (#36678) 2018-02-24 21:45:25 +01:00
Dag Wieers
5da948f792
Fix rendering docsite on smartphone/tablets (#36675) 2018-02-24 17:16:40 +01:00
Dag Wieers
3016bc7351
Asorted docs fixed (#36672)
This PR includes:
- A fix to untemplated {{ plugin_type }} in docs
- Remove the additional info on how to edit module docs (see #36667)
- Add missing delimiter
2018-02-24 14:06:12 +01:00
Dag Wieers
ba370b178d
docsite: Add 'Edit on GitHub' for module docs (#36667)
This is something I always wanted, a 'Edit on GitHub' button for module
documentation.

I also removed the additional statement in the footer with instructions
on how to edit the module documentation.

PS The links go directly into the GitHub file editor now !
2018-02-24 03:57:37 +01:00
scottb
dc902a5022
Fixes broken nested tables in module docs (#36144) 2018-02-13 15:21:10 -08: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
Lars Kellogg-Stedman
29fbf0c756 remove erroneous '.' in docsite footer (#34592)
This removes an erroneous '.' in the docsite that someone pointed out
on irc.
2018-01-08 22:36:47 -08:00
Wolfgang Felbermeier
817a5efff9 Fix css of elbow indentation for firefox (#33225) 2017-11-27 13:13:17 +10:00
Wolfgang Felbermeier
496ce388ab documentation: render nested return dicts for more then one level (#33143)
* Render nested return value documentation for more then one level
in the generated webdocs.

* Remove unnecessary code and cleanup

* Implement recursive option documentation

* Build elbow intendation style for options and return documentation
2017-11-22 16:53:53 -05:00
Matt Davis
59787a3dbc minor fixes to docsite root URLs (#28945)
* fix hardcoded http schemes to use relative URLs
* add doc fragment to version selector link to scroll target directly to the selector
2017-09-01 16:48:53 -07:00
Scott Butler
c479d37777 Changed header to say 'devel' instead of 2.4 2017-09-01 15:37:07 -07:00
Shane McDonald
f108057f61 Bump version in docs layout (#28523) 2017-08-22 20:16:19 +01:00
scottb
b5179f9d46 CSS and HTML updates to enable versioned core documentation (#28097)
* Updated header for versioned docs.

* A tree in a golden forest.

* Fixed spacing.

* Fixed CSS and text for previous version header.
2017-08-14 11:21:33 -07:00
Scott Butler
087159c4cd Switch Adobe tracking off staging. 2017-04-17 13:36:31 -07:00
scottb
fb48c45adf Added Adobe DTM tracking. (#22889) 2017-03-22 19:37:01 -07:00
Chris Alfonso
b2a10e6e4b Bumping docs footer copyright year (#22210) 2017-03-02 22:15:19 -08:00