20 Commits

Author SHA1 Message Date
Ron Stone
8972c8884b Fix version menu
Latest seems to require a match in list of available
branches. Adding.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I2cbac1f62dabd0e661b265deba2b604c01fc9821
2022-11-03 06:43:00 -04:00
Ron Stone
be1b390e74 Fix menu
Fix typo in version menu definition
Switch value of starlingxdocs_plus_this_version on master to "Latest"

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I6aa1a34589a07253a89f6092756a132a5361b82c
2022-10-18 07:27:17 -04:00
Ron Stone
b4d3e4e23f Update version menu
Add "Latest" pointer to master.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I6553b91844cdc9648b980b882256f0318b05144e
2022-10-12 20:04:38 +00:00
Elisamara Aoki Goncalves
722197e9e9 TEST
Branch test


Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: I786c4356f5af40258139b58a67fc300ee1062c65
2022-09-08 11:37:47 -03:00
Ron Stone
9b2ae6fc20 Prep Sphinx for r7
Add Release 7 to Version switch drop-down.
September 7th the Stx 7.0 GA Release. Merging this review to enable the drop-down

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I707d87ed5714cc1992553ab85d83bb7387566b22
2022-09-07 15:40:11 +00:00
Ron Stone
f95ffd6878 Spell check config updates.
Continuation of https://review.opendev.org/c/starlingx/docs/+/826142
Move sphinxcontrib.spelling dependency out of 'docs' build env
Minor updates to spelling_wordlist.txt for testing
Note: shared/strings.txt do not current load into spellcheck env. This causes
numerous warnings but does not interfere with spell check. More investigation
TBD.
Note above no longer relevant. Fixed.
Incorporated Patchset 1 review comments.
Remove terms from wordlist
Exclude Chinese doc from EN-US spellcheck
Updates to wordlist
Resolve merge conflicts.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I78639c2dc468f9132297b75280ba373d05c28233
2022-02-10 10:07:55 -05:00
Zuul
1bdef7dab5 Merge "Implement preflight checks - spellcheck - linkcheck Implemented as distinct environments to prevent premature exits on error. Add 'enchant' C library via bindep" 2022-02-01 20:11:20 +00:00
Ron Stone
7271e6bc45 Implement preflight checks
- spellcheck
 - linkcheck
Implemented as distinct environments to prevent premature exits on error.
Add 'enchant' C library via bindep

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I61912b7601719649655dd9dae86800f8b33d58f8
2022-01-27 13:11:56 -05:00
MCamp859
60e17b5104 Update version picker in main branch
Update conf.py in main branch to enable R6 version selection.
Updated main index page to fix link to R6 ISO.

Change-Id: I1bfc6492bc881a50d8e25454a1fcdd17e5ab08b9
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2022-01-26 21:47:30 -05:00
MCamp859
53d86a6d49 Enable version picker in master branch
Update conf.py in master branch to turn on doc version selection.

Change-Id: I4420c496a136e6183412aed704aab59e1354fa63
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-04-30 15:18:02 -04:00
MCamp859
6314f8bb36 Adds starlingxdocs_plus theme for version button
This theme extends legacy openstackdocstheme and starlingxdocstheme.
This first patch set to test theme additions.
Button is not displayed in this patch.

Change-Id: I3bedd09e63e7706ff6da3e5a4a87cc460dacd99a
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-03-03 14:13:23 -05:00
Ron Stone
d99ab454f1 Changes to support conditionalizing rST 'substitutions'
Base set of substitutions added for organization name, product
names, document names amd rubrics.

This amendment adds a substitition for StarlingX OpenStack.

Change-Id: I236c193ae3a526a3903afa23a0a86db7d61f1244
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2020-09-16 08:20:32 -04:00
MCamp859
965e7aebe6 Updates to HTML theme completed
Updated conf.py to enable "show_other_versions"

Made clerical edits to test new theme output

Change-Id: I7637a18204004383220ae723cb42eb94e4d5bebd
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-15 14:18:24 -04:00
MCamp859
09d65eac3f [WIP] Revert pygment style setting
Update to openstackdocstheme changed code snippets display style.
Revert to previous setting for better readability.

Closes-Bug: 1883966

Change-Id: Ibdf84da05ad4f6dbd8342c58ad215a9a3e68d6a7
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-06-18 16:45:23 +00:00
Andreas Jaeger
b8cfb53f19 Update docs building
Several reorgs:
* setup.cfg/setup.py must be in top-level dir so that siblings
  (installing for example openstackdocstheme from source instead of
  pip) works.
* Update openstackdocstheme version (see below)
* Remove unused entries from setup.cfg
* Remove py27 code from setup.py
* Update tox.ini for a py3 only world and cleanup

Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I27039f9dc52c3e6c9e667b5699172d0f834e8f6b
2020-06-04 14:01:52 +02:00
Kristal Dale
841b900aad - Use updated project name in titles/text
- Correct text for link to Storyboard (docs)
- Correct capitalization in section headings
- Correct formatting for section headings
- Update project name in link to release notes, api-ref
- Update project name in config for docs/releasenotes/api-ref

Story:2007193
Task:38353

Change-Id: I2364abf50b218acb8b58f83f8a09c4b553d2e469
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:41:40 -08:00
Kristal Dale
9690fc0c3e Update config
Removed duplicate entry in conf.py for version and release
variables. Set both version and release to empty string, so
that the string above left nav renders only the project name.

Story: 2004900
Task: 29220

Change-Id: I7dbbbd78dc33841baec32ef1d48a5ab3dc1fd860
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-30 15:53:14 -08:00
Dean Troyer
d220b08b34 Switch to new starlingxdocs theme
Change-Id: Id6bb154b509a5cb822cd1f32167f48ba7876645a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-19 06:30:45 -05:00
Dean Troyer
b003280698 Add the publish job
We have the AFS volume and now a publish job, let's see if we
can get from here to there.  Include a docs change to ensure
the jobs actually run.

the web server is near, pending certificate installation.

Change-Id: I325e97f0500e66b57b7d1cd2d2e81bee79c67f30
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-02 16:29:20 -05:00
Dean Troyer
d4fd23d60b Update base with current OpenStack PTI config
* rename docs to doc
* adds conf.py
* adds tox 'docs' environment and sphinx-build call
* remove bashate from linters env
* clean yaml lint error

Change-Id: I9cbacea395b13554162f955ddb57e54365952f95
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-07-23 16:14:10 -05:00