Commit Graph

12 Commits

Author SHA1 Message Date
Kefu Chai
cbb8f8433e doc/dev/generatedocs.rst: fix highlight syntax
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-18 10:26:15 +08:00
Kefu Chai
34f74e8a37 admin/build-doc: add livehtml target
it is time-consuming to rebuild the python bindings every time we
rebuild the document, it'd be ideal if we could just build document.

in this change, in addition to "html" and "doc", "livehtml" argument is
now supported by build-doc script, so one can just use

./build-doc livehtml

to build and start a web server. whenever a change in doc/ is detected,
the document is rebuilt. for more details, see
https://pypi.org/project/sphinx-autobuild/

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-11 22:30:56 +08:00
James McClune
b8317f5e1e
doc: added demo document changes section
Added a brief section about how to demo Ceph documentation
changes. 

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-10-28 01:44:17 -04:00
Kefu Chai
776329abe1 doc: fix some redirected links reported by "build-doc linkcheck"
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-06-01 17:00:06 +08:00
lafont
54ec7556bc doc: update the "building doc" part
* In the doc, the explicit and outdated list of required
  dependencies is removed. Now, launching `./admin/build-doc`
  is suggested because the script gives the missing dependencies.
* Little refactoring of the "Debian checking dependencies" part
  in the script `./admin/build-doc`.
* In the suggested "apt-get" command to install dependencies, the
  option `-o APT::Install-Recommends=true` is added just in case.

Signed-off-by: François Lafont <francois.lafont@ac-versailles.fr>
2016-05-18 16:23:08 +02:00
Nathan Cutler
eadc771d27 doc: Update list of admin/build-doc dependencies
http://tracker.ceph.com/issues/14070 Fixes: #14070

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-15 12:41:29 +01:00
Dan Mick
dcbdeaf6d1 doc: Fix repo URL for Ceph cloning (dev/generatedocs)
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2013-09-03 15:56:53 -07:00
Loic Dachary
fd0626108a ant is missing from the list of packages to install
to build the documentation.

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-08-09 10:17:26 +02:00
Sage Weil
69a96bb513 doc: clean up doc build directions
Signed-off-by: Sage Weil <sage@inktank.com>
2012-10-19 10:40:25 -07:00
Tommi Virtanen
5465e81097 doc: Whitespace cleanup.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-03 10:15:21 -07:00
John Wilkins
a1b31ddfda Initial cut of introduction, getting started, and installing. More to do on installation. RADOS gateway to follow.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:54 -07:00
John Wilkins
d3a2c56566 doc: move documentation build instructions to doc/dev section
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 11:21:12 -07:00