| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
Change-Id: I70f0112f1ee3066ffd9316d10b84b9ea5b7fc306
|
| |
|
|
|
|
| |
Change-Id: I304a460f88f3f8ee33cf642355f0e659184db724
Story: #2006963
Task: #40727
|
| |
|
|
|
|
|
|
|
|
|
|
| |
Currently the index page contains a brief introduction and 3 links.
Expand the table of contents to show more subheadings.
Clean up the install, admin and contributing docs of unnecessary
and wrong content and redundant headings.
Update URLs throughout the text.
Change-Id: I03279ffc9faf387b08f727dee3b8898a69918460
|
| |
|
|
| |
Change-Id: Id7c5686cdbdc79812e06eb4a5f87eddc75005cc3
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
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.
This repo uses storyboard, configure the proper variables.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: Id084bfc9d5ae7a95d3cba22a00b4c03a35967ee4
|
| |
|
|
|
|
|
|
|
| |
WSME is no longer maintained and Pecan is an overkill for our (purely
internal) API. This change rewrites the API in Werkzeug (the library
underneath Flask). I don't use Flask here since it's also an overkill
for API with 4 meaningful endpoints.
Change-Id: Ifed45f70869adf00e795202a53a2a53c9c57ef30
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.
TeX packages are required to build PDF locally, following is recommended:
* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended
More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems
Change-Id: If5446ce4ceee7e38a0052503aa8fc2b6c5d7de66
|
| |
|
|
|
|
|
|
|
|
|
|
| |
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: I38d3f05ce9d6a32a0c4e5d44df13e527aa629b2e
|
| |\ |
|
| | |
| |
| |
| |
| |
| |
| | |
This patches removes unnecessary utf-8
encoding in doc/source/conf.py
Change-Id: I864658137f58e78cd275cf8de7b0774a8d7991cb
|
| |/
|
|
| |
Change-Id: I1aecf894955e8095c11b8fb82d60488e5d0aca5f
|
| |
|
|
|
|
|
|
|
|
|
| |
This change removes the now unused "warnerrors" setting,
which is replaced by "warning-is-error" in sphinx
releases >= 1.5 [1].
[1] http://lists.openstack.org/pipermail/openstack-dev/
2017-March/113085.html
Change-Id: I9bf18ff72f36dfd3496b9672604e8bb98999b133
|
|
|
This adds and configures a sphinx doc builder. This is based on the code
in Ironic to build documentation.
The goal is for this to contain development documentation relevant to
hacking on the agent, including how to make custom HardwareManagers.
Change-Id: Ib6cecb9959f4ad5c71440fb37827b996582a9545
|
