8 Commits

Author SHA1 Message Date
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
e3a11084e2 Add project links and pages for API Ref and Release Notes
The project-specific docs are published independently so we need
to maintain the links into those subtrees (/stx-*), also
for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*).

Also add docs env to the default list in tox.ini.

Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-18 19:13:22 -05:00
Kristal Dale
ed5bddca67 Apply proposed doc organization and migrate wiki content
1. Updated index page to include toctree for proposed organization of docs. Updated sample content (this needs to be finalized - SAMPLE content only).
2. Added Installation Guide page. Migrated content from wiki to docs (reST).
3. Added Developer Guide page. Migrated content from wiki to docs (reST).
4. Updated Contribute page to link to 2 child pages
- Added API Contributor Guide page. Migrated content from wiki to docs (reST).
- Added Release Notes Contributor Guide page. Added draft content from etherpad (reST).
5. Removed trailing white space in files (patch)

Depends-On: https://review.openstack.org/#/c/611078

Change-Id: If4448fcc096f8fdcdf0d88c31b6b42ea94aea1fd
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-10-18 10:24:30 -07:00
Dean Troyer
f253a48c45 Add api-ref publish job
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref job
* Add search at bottom of api-ref and relnotes pages to trigger the jobs
* Add openstackdocstheme installation into requirements file

Change-Id: I11db7e584f3e16f1fd0517a5c0059bdc2d448399
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-12 18:32:17 +00:00
Dean Troyer
1f08250553 Correct the top-level specs link
Change-Id: I000ade7aa9cf2b692c17f7a59913a31c569f7a6d
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-04 15:03:56 -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
51c2529fe2 Add docs build jobs
Start with building Sphinx, include links to the anticipated locations
for /releasenotes and /specs.

Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-09-04 09:58:56 -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