11 Commits

Author SHA1 Message Date
lpiwowar
19c3056754 Use stestr instead of testrepository
This patch removes dependencies on testrepository as
stackviz is using stestr instead.

Closes-Bug: 1735667
Change-Id: I1e1de567fae7a2f7985f51e35d71201be2ab787f
2021-06-16 08:59:37 +02:00
Ghanshyam Mann
9c755dbe5b Update IRC network to OFTC
Change-Id: Ibad52069b8cf1f00d0ba3c427ff4141fc4b52539
2021-05-31 15:04:43 -05:00
Lukas Piwowarski
ee58754040 Create tox environment to build pdf documentation
This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.

Story: 2006070
Task: 35471

Change-Id: I44b0dde9cec10359dd41cbf9a2d9b034a831f106
2020-09-24 10:23:01 +02:00
Andreas Jaeger
a2c25d956c Switch to newer openstackdocstheme version
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: I3613f3b9e1f12fd7735f1dba6918a68784d9c259
2020-06-02 14:22:28 +02:00
Ghanshyam Mann
0469f86182 [ussuri][goal] Update contributor documentation
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html
Story: #2007236
Task: #38554

Change-Id: I11f746df8ddfba5cf0b1e33778c9939a0a5fc760
2020-04-22 14:04:30 +00:00
Masayuki Igawa
7eccb67849
Fix indentations in docs
This commit fixes some indentations in stackviz docs. These indentations
are weird. There's no specific reason to keep it.

Change-Id: Ib9805b5c7d3ba5a4b44045424fed4493322dcd67
2017-12-18 13:50:02 +09:00
Masayuki Igawa
6fb81ff38a
Fix docs and update its theme
This commit fixes the stackviz docs to show some manual pages and some
tiny sectioning. And this commit also updates to use the new theme.
There are still remaining weird indentations and some other tiny
formatting bugs. However, we can fix them in following patches.

Change-Id: I1ab055efb9bc5653f98be165cd2be3ac9cc5cd27
2017-12-01 16:31:09 +09:00
Ian Wienand
3a31512b8d Correct stream-file argument
I found out the hard way this argument name is incorrect :)

Change-Id: I1f947f7f6def95298ae67240a6af2ebdd55d60f5
2016-09-02 10:53:11 +10:00
Austin Clark
e3af3b2bd3 Add to stackviz-export and stackviz-front docs
Adds additional information to the stackviz-export and stackviz-front
technical documents. Info about `stackviz-export` output files is
now included in the corresponding document. Directive and service
descriptions were added to stackviz-front, alongside inline comments
in the appropriate .js files.

Due to the unique structure of GitHub's RST renderer, includes will
no longer be used in the main README.

Change-Id: Iaebf1f1c3b5e4cbb4ea5e262f85672bc082bbe2f
2016-04-14 10:18:28 -06:00
Austin Clark
f3848085e1 Restructure Stackviz docs
This patch changes the format of Stackviz docs so that all information
is stored in the appropriate doc/source/ directory rather than all
in README.rst. README.rst now just uses the RST include directive to
get its text from doc/source/readme.rst. Usage and installation are
now in their own RST files for increased modularity, and are included
in doc/source/readme.rst.

Additional developer documentation has also been created at
doc/source/man/ and includes more information on stackviz-export
as well as the AngularJS front-end.

Change-Id: I1d37194add998cf83a66d380ec7390e31184bdb3
2016-03-22 11:54:57 -06:00
Tim Buckley
4bf57c7152 Convert README to rst, and add documentation template from cookiecutter 2015-08-03 10:15:34 -06:00