ansible

Commit Graph

Author	SHA1	Message	Date
Toshio Kuratomi	3f784caed1	Table fixing (#60177 ) * Change formatting of the network/user_guide tables * Tables had hardcoded line breaks to workaround a bug in the read-the-docs theme. Change those so that they now flow according to the browser size. * Also switch away from grid tables to the simpler to create and read simple tables * Changes to table stylesheet * valign all content, not just the first column. This becomes important with more than two columns * Set the font-weight to the first <p> element inside of the first column. This allows us to simplify the first column when everything there is the attribute name * Change platform_index footnote from numbered to dagger symbol The footnote notation was very odd to read. Try using a symbol for the footnote instead of a number to see if that will clarify it. We can't manually specify symbolled footnotes, though, so we have to emulate a footnote with an internal link. This loses the backref to each place that the footnote was used but since that was the portion which was hard to read, perhaps that's for the best.	7 years ago
Toshio Kuratomi	d9b3af523b	Galaxy meta docs table (#60171 ) * Use an rst table instead of a raw html table * Rst is easier to read so we want to use it wherever possible * Fix the jinja2 filters which create links so that they do not include extraneous whitespace in the URL * Normalize description data before sending them to the templates	7 years ago
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.	7 years ago

Author

SHA1

Message

Date

Toshio Kuratomi

3f784caed1

Table fixing (#60177 )

* Change formatting of the network/user_guide tables

* Tables had hardcoded line breaks to workaround a bug in the
  read-the-docs theme.  Change those so that they now flow according to
  the browser size.

* Also switch away from grid tables to the simpler to create and read
  simple tables

* Changes to table stylesheet

* valign all content, not just the first column.  This becomes important
  with more than two columns
* Set the font-weight to the first <p> element inside of the first
  column.  This allows us to simplify the first column when everything
  there is the attribute name

* Change platform_index footnote from numbered to dagger symbol

The footnote notation was very odd to read.  Try using a symbol for the
footnote instead of a number to see if that will clarify it.  We can't
manually specify symbolled footnotes, though, so we have to emulate a
footnote with an internal link.  This loses the backref to each place
that the footnote was used but since that was the portion which was hard
to read, perhaps that's for the best.

Toshio Kuratomi

d9b3af523b

Galaxy meta docs table (#60171 )

* Use an rst table instead of a raw html table

* Rst is easier to read so we want to use it wherever possible
* Fix the jinja2 filters which create links so that they do not include
  extraneous whitespace in the URL

* Normalize description data before sending them to the templates

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.

3 Commits (f4fa4e4e0ef0ac0ec57dfa8f479ced461d62c52a)