Commit Graph

10 Commits

Author SHA1 Message Date
Reyes, Amy fcc8edac38 doc: add 3.1 to /latest header note
Signed-off-by: Reyes, Amy <amy.reyes@intel.com>
2022-09-26 10:07:26 -07:00
David B. Kinder bac00cdec8 doc: add 3.0 to /latest header note
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-06-29 17:37:51 -07:00
David B. Kinder 81336a8ee4 doc: use Sphinx extension for showing last updated date in footers
Remove the proof-of-concept shell script that post-processes the
generated HTML to add the git date when the corresponding .rst file as
the last modified date, augmenting the existing published date.

Instead, use a custom last_updated.py Sphinx extension that's integrated
into the Sphinx build itself. Remove the old fix-git-modified-date.sh
script and calls to it.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-03-18 11:05:50 -07:00
David B. Kinder eed4ef3ab8 doc: add header notice on latest documentation from master
The master branch is considered unstable and under development. We need
to remind developers of this and refer them to the available stable release
documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2022-03-01 14:25:32 -08:00
David B. Kinder f300d1ff77 doc: update breadcrumb to include release version
As a DX improvement in the documentation, include the release version
(or Latest) in the breadcrumb header on every page.  This can help
readers know which release version documentation they're using.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-10-01 14:53:29 -07:00
David B. Kinder fe470cfe23 doc: make doc version selector more obvious
Move the doc version selector menu higher on the left nav to make it
more visible (from its prior bottom of the nav menu)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-04 14:47:23 -07:00
David B. Kinder 6c54cba985 doc: cleanup css, search, version choices
Update CSS customization to improve read-the-docs theme for our use.
Improved search results (removing most reST markup), improve display of
doc version choices.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-26 14:00:49 -07:00
David B. Kinder d11729d9d8 doc: add doc contributing guide, plus cleanup
Add documentation contributing information with project specific
recommentations along with some common reST and Sphinx constructs.
Reorganize contributing section to fit this new doc in.

Also

* Cleanup stray file (CODEOWNERS) from when docs were in their own repo.
* Remove licensing footer on generated pages (not really needed).
* Pull replacement strings into substitutions.txt for easier management.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-23 08:44:56 -07:00
David B. Kinder b997e590f2 doc: add support for publishing versioned docs
add navigation to (manually) maintained list (in conf.py) of versioned
docs, and update generating and publishing processes to be
version-aware.

Adds a file to redirect root references to /latest folder now (since we
can't update the server redirects).  Might break some links to pages
within the site from external sites.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:25:54 +08:00
David B. Kinder c8d2cdccda doc: update project documentation LICENSE
Per Project ACRN governance, documentation is under a Creative Commons
Attribution 4.0 International License (CC BY 4.0).  This patch updates
this information, and adds a tagline to documentation mentioning this
license.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00