Commit Graph

36 Commits

Author SHA1 Message Date
Sage Weil
2a0d6ddbc0 doc/conf.py: fix man page build vs governance.rst
Signed-off-by: Sage Weil <sage@redhat.com>
2018-06-05 16:18:36 -05:00
Nathan Cutler
820dac980e
Merge pull request #20876 from smithfarm/wip-doc-license
legal: remove doc license ambiguity

Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
Reviewed-by: Ken Dreyer <kdreyer@redhat.com>
2018-03-19 14:29:54 +01:00
Nathan Cutler
e294dd5910 legal: remove doc license ambiguity
The license applicable to the files under doc/ was originally declared (in the
top-level file COPYING) to be "Creative Commons Attribution-ShareAlike (CC
BY-SA)" by ed0653b493

This license declaration omitted a version number.

Some time later ef7418421b was merged, mentioning
CC-BY-SA-1.0 as one of the Ceph source code licenses. Although the purpose of that
commit was only to summarize the canonical license information from COPYING, it
unintentionally became the only place in the source code where the doc license
version was specified.

In March 2018, the Debian project warned that CC-BY-SA-1.0 does not meet its
criteria for inclusion in the "free" section of the Debian distribution. (For
that, at least version 3.0 must be used.)

This new commit removes the doc license ambiguity by setting it to CC-BY-SA-3.0
in all places where the license is mentioned.

The exact spelling of the license name is taken from https://spdx.org/licenses/

Fixes: http://tracker.ceph.com/issues/23336
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-03-13 18:59:02 +01:00
Abhishek Lekshmanan
d9a42eb42a doc: add releases to conf.py
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2018-03-07 23:50:28 +01:00
Kefu Chai
220e038dc5 doc/mgr: document mgr/plugin using automethod
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-11-02 14:34:13 +08:00
Kefu Chai
fda079d5ed doc: switch to upstream sphinx-ditaa
it works with setuptools and is now compatible with py3

the py3 branch is created to track the upstream's master branch

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-09-11 23:05:26 +08:00
Kefu Chai
335205bafa doc/conf.py: do not set html_use_smartypants explicitly
because it's deprecated, and is on by default in the specified sphinx
version (v1.6.3):

this change silences following warning:

build-doc/virtualenv/local/lib/python2.7/site-packages/sphinx/environment/__init__.py:683:
RemovedInSphinx17Warning: html_use_smartypants option is deprecated.
Smart quotes are on by default; if you want to disable or customize
them, use the smart_quotes option in docutils.conf.
  RemovedInSphinx17Warning)

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-08-22 11:24:13 +08:00
Alfredo Deza
9ca04aa852 doc ignore ceph-volume when building man pages
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:44:54 -04:00
Alfredo Deza
f78a991f59 doc exclude man_index when not building man pages
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:20:02 -04:00
Alfredo Deza
8e06659c34 doc: exclude mgr from man pages, define a man index.rst
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:20:01 -04:00
Patrick McGarry
87c579cebe Merge remote-tracking branch 'origin/master' 2016-08-01 15:59:08 -04:00
Kefu Chai
65de919ec3 doc: add breathe_domain_by_extension to conf.py
so it can render the doxygen generated objects with the proper domain by
checking the extension of rendered source file.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-05-31 18:34:32 +08:00
Kefu Chai
0e00d2f21b doc,cmake: do not scan non-man pages when building man pages
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-05-24 12:58:43 +08:00
scuttlemonkey
750f162a39 update copyright 2016-01-19 14:48:09 -05:00
Kefu Chai
301fe6cbf2 doc: generate man pages in man/Makefile
* move rst files from doc/man/8 into man/8
* extract man_pages setting for sphinx from doc/conf.py to man/conf.py
* generate all man pages in `make install`
* add python-sphinx to Build-Depends
* check for sphinx-build in `configure`
* run changed rst files through sphinx-build in `make check`

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-24 12:36:41 +08:00
Kefu Chai
cd69ded7af doc: Switch doxygen integration back to breathe
* asphyxiate needs more toolings, see
  https://github.com/ceph/asphyxiate/issues/1
* this commit basically reverts c96064
* use `autodoxygen` directive to doxygen referenced source files
* do not call `doxygen` explicitly in `build-doc`, `autodoxygen`
  will take care of it.

Fixes: #6115
Fixes: #6115
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-20 17:17:16 +08:00
Kevin Dalley
f1d412c303 doc: Common graph used in 2 quick start files
The graph in quick-ceph-deploy.rst applies to
quick-start-preflight.rst.
The graph in deploy seems more complete, so I put the common
documentation in quick-common.rst and had it included.
doc/conf.py has 'start/quick-common.rst' in exclude patterns so that
sphinx does not complain about this file not being in toc.

Signed-off-by: Kevin Dalley <kevin@kelphead.org>
2014-05-07 18:01:52 -07:00
Alfredo Deza
6ec28fd92c ensure pybind is in the PYTHONPATH
Signed-off-by: Alfredo Deza <alfredo@deza.pe>
2014-03-24 14:52:45 -04:00
Loic Dachary
b4054fcc8d doc: copyright s/2013/2014/
Signed-off-by: Loic Dachary <loic@dachary.org>
2014-01-12 18:06:06 +01:00
Dan Mick
4fe52a7ff4 Revert "Update conf.py"
This reverts commit 7008992062.
Apparently github's edit lets you commit directly to the repo.
Oops.
2013-03-08 15:46:34 -08:00
Dan Mick
7008992062 Update conf.py 2013-03-08 15:44:28 -08:00
John Wilkins
007c83db1b doc: Updated year in footer.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-03-04 11:48:14 -08:00
Ross Turk
53b354dfaa doc: update copyright to include contributors, CC
Signed-off-by: Ross Turk <ross@inktank.com>
2012-10-25 17:51:04 -07:00
Ross Turk
4d7bb07561 doc: update copyright notice in footer
Signed-off-by: Ross Turk <ross@inktank.com>
2012-07-05 15:24:42 -07:00
Ross Turk
cabe74b19e doc: new theme
Signed-off-by: Ross Turk <ross.turk@inktank.com>
2012-05-03 11:03:03 -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
Tommi Virtanen
c960641666 doc: Switch doxygen integration from breathe to asphyxiate.
TODO: path of librados.h is now just the basename

TODO: no enum support for now

TODO: no @bug support for now

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-01-09 19:03:56 -08:00
Tommi Virtanen
200d7c89a6 doc: Switch diagram tools from dia to ditaa.
Now you can create diagrams easily with the ".. ditaa::"
directive in the Sphinx documents.

admin/build-doc now checks for debs required for building
the documentation, or just lists commands missing for hosts
not using dpkg.

For more on Ditaa, see http://ditaa.sourceforge.net/

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-06 12:07:59 -08:00
Mark Kampe
4cfe0815cb doc: change state model from .svg to .png
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:07:41 -08:00
Samuel Just
1c696b6566 doc: Add peering state diagram
Signed-off-by: Samuel Just <samuel.just@dreamhost.com>
2011-11-29 16:35:59 -08:00
Josh Durgin
c00e06f697 doc: add documentation for librbd python bindings
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-09-30 11:37:15 -07:00
Tommi Virtanen
66ee58f691 doc: Move internals into a new section, /dev.
Most of the doc is user-oriented, let's isolate internals more.

Split into multiple files. Clean up RST.

Use Sphinx's graphviz plugin for graphs.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-01 13:28:12 -07:00
Tommi Virtanen
df0f32b73a doc: Disable static file copying, we don't use it.
Avoids a warning from sphinx on every run.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 12:38:37 -07:00
Tommi Virtanen
c85c2f7535 doc: Adjust how table of contents is presented.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 11:26:56 -07:00
Tommi Virtanen
afede55c83 Integrate Doxygen into Sphinx docs.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00
Tommi Virtanen
f1d8964499 First draft of the documentation overhaul.
To build the docs, run ./admin/build-doc. To browse them, either get
them on any static website, or just run ./admin/serve-doc to serve
them quickly off of port 8080.

build-doc sets up a virtualenv to avoid needing Sphinx installed
system-wide. serve-doc needs thttpd installed.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00