Commit graph

53 commits

Author SHA1 Message Date
Alicia Cozine
33924d7e8d
gives each banner a unique div ID ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-06-03 16:51:31 -04:00
Alicia Cozine
62fc4ad8da
adds banner for GalaxyNG survey () 2021-06-03 11:22:49 -04:00
Scott Sinclair
325ccf22fe
Fix issue with version 3 in docs version list ()
Previously would subsitute the "3" in "s3" instead of the version location in the URL
2021-04-19 18:33:35 +02:00
Alicia Cozine
29d3951464
Docs: Adds banner for core/package split ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-02-23 15:54:17 -05:00
Alicia Cozine
1d8760779c
left a stray </div> by mistake ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-01-06 12:13:24 -05:00
Sandra McCann
0a3c5d9dcc
remove doc survey banner () 2021-01-05 15:40:20 -06:00
Sandra McCann
6098793315
add docs survey banner ()
* add docs survey banner, with date
2020-12-08 15:09:35 -06:00
Sandra McCann
d76f85208d
clarify upstream release status of 2.10 ()
* clarify upstream release status of 2.10

* wordsmith
2020-11-03 11:39:27 -05:00
Sandra McCann
3ece57c01a
remove ansibleFest banner () 2020-10-20 13:18:16 -05:00
Sandra McCann
80b8fde946
update fest link () 2020-08-20 09:40:51 -05:00
Sandra McCann
9be8d723da
Add Fest banner ()
Adds Fest banner, with fixes; updates existing banners, adds links.
2020-08-19 15:19:53 -05:00
Alicia Cozine
8313cc8fb1
Warning banner should only show on /devel/ docs, not on pages with 'devel' in their titles ()
* banner should not be placed on pages with 'devel' in their titles

* Update docs/docsite/_themes/sphinx_rtd_theme/ansible_banner.html

Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>

* Only match paths at the beginning

Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>
2020-08-03 16:56:55 -04:00
Sandra McCann
e28b20d729
remove github link from plugins () 2020-07-30 14:43:07 -05:00
Toshio Kuratomi
9dda393d70
Collections docs generation ()
* Build documentation for Ansible-2.10 (formerly known as ACD).

Builds plugin docs from collections whose source is on galaxy

The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.

* Update the python syntax checks
  * docs builds can now require python 3.6+.

* Move plugin formatter code out to an external tool, antsibull-docs.
  Collection owners want to be able to extract docs for their own
  websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs

* Cleanup and bugfix to other build script code:
  * The Commands class needed to have its metaclass set for abstractmethod
    to work correctly
  * Fix lint issues in some command plugins

* Add the docs/docsite/rst/collections to .gitignore as
  everything in that directory will be generated so we don't want any of
  it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages

* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs

* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined

* Remove references to plugin documentation locations that no longer exist.
  * Perhaps the pages in plugins/*.rst should be deprecated
    altogether and their content moved?
  * If not, perhaps we want to rephrase and link into the collection
    documentation?
  * Or perhaps we want to link to the plugins which are present in
    collections/ansible/builtin?

* Remove PYTHONPATH from the build-ansible calls
  One of the design goals of the build-ansible.py script was for it to
  automatically set its library path to include the checkout of ansible
  and the library of code to implement itself.  Because it automatically
  includes the checkout of ansible, we don't need to set PYTHONPATH in
  the Makefile any longer.

* Create a command to only build ansible-base plugin docs
  * When building docs for devel, only build the ansible-base docs for
    now.  This is because antsibull needs support for building a "devel
    tree" of docs.  This can be changed once that is implemented
  * When building docs for the sanity tests, only build the ansible-base
    plugin docs for now.  Those are the docs which are in this repo so
    that seems appropriate for now.
2020-07-17 13:07:35 -07:00
Matt Clay
4816bb4f43
More boilerplate fixes. ()
* Fix boilerplate in hacking dir.
* Fix boilerplate in docs dir.
* Fix boilerplate in integration tests.
* Fix boilerplate in examples.
2020-06-22 19:05:30 -07:00
Sandra McCann
0d379d4205
Explain module docs loss for devel () 2020-03-25 13:55:05 -05:00
Abhijeet Kasurde
2728c2476e
docs: Fixed "Edit on GitHub" link for plugin, cli ()
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 ()
* 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. ()
* 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 ()
* update version metadata to get faceted swiftype search running
2019-12-05 15:16:34 -06:00
Sandra McCann
de826b437d Minify theme ()
* 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 ()
* 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 () 2019-07-18 14:15:43 -05:00
Sandra McCann
35b6345bdc Add a banner message to warn when not on latest documentation ()
* 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 ()
* 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 ()
* improve breadcrumbs
* get edit on github working again
2019-06-05 14:26:34 -05:00
Sandra McCann
f9b43a0f68 Copyright fix for 2018 ()
* 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 ()
* 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 () 2019-04-18 11:26:10 -05:00
Bianca Henderson
51ac4d3441 Update Ansible docsite CSS to fix multi-page printing issue ()
* 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 ()
* 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 () 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 ()
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 () 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. () 2018-04-06 20:34:31 -07:00
scottb
2381d2207e
Additional docs CSS fix for mobile () 2018-04-05 23:59:18 -07:00
scottb
79c5a34b0b
Fixes CSS so docs display properly on mobile () 2018-04-05 23:20:24 -07:00
Dag Wieers
cdf9e39647 Fix the automatic docsite_pr label () 2018-04-05 10:48:37 -07:00
scottb
68f81a6799
Reinstated element to fix doc display on mobile devices. () 2018-04-03 17:13:29 -07:00
scottb
3554e2c2d9
Fixes scrolling issue without breaking header nav () 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. () 2018-03-23 17:36:56 -07:00
scottb
0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. () 2018-03-16 21:35:41 -07:00
Dag Wieers
eb52a88fb6 Improve module docs return values ()
* 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 ()
* Remove Sphinx/Read-the-Docs plug on every doc page

No need to have this on every page.

This fixes 

* 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 ()
* 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
Dag Wieers
e520ff2e99
docsite: Improve previous fix for smartphone/tablet () 2018-02-24 21:45:25 +01:00
Dag Wieers
5da948f792
Fix rendering docsite on smartphone/tablets () 2018-02-24 17:16:40 +01:00
Dag Wieers
3016bc7351
Asorted docs fixed ()
This PR includes:
- A fix to untemplated {{ plugin_type }} in docs
- Remove the additional info on how to edit module docs (see )
- Add missing delimiter
2018-02-24 14:06:12 +01:00