Commit graph

13 commits

Author SHA1 Message Date
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
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
Sandra McCann
0d379d4205
Explain module docs loss for devel () 2020-03-25 13:55:05 -05: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
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