Simplify install doc dir structure
- Remove r6 directory
- Rename r7 directory to be non release-specific
- Delete unused files
- Delete obsolete include files
- Delete obsolete commented sections in install topics
- Remove redundent version menu entry
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I59634826d4b3af41410e9d26cc182f6b4aed8ade
Latest seems to require a match in list of available
branches. Adding.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I2cbac1f62dabd0e661b265deba2b604c01fc9821
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
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
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
- 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
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>
Update conf.py in master branch to turn on doc version selection.
Change-Id: I4420c496a136e6183412aed704aab59e1354fa63
Signed-off-by: MCamp859 <maryx.camp@intel.com>
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>
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>
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>
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
- 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>
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>
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>