Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add optional argument for build-doc #14058

Merged
merged 2 commits into from
Mar 21, 2017
Merged

doc: add optional argument for build-doc #14058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b9ec53
admin/build-doc: support optional argument for specifying sphinx buil…
tchaikov Mar 21, 2017
e423f0b
doc: cephfs: fix the unexpected indent warning
tchaikov Mar 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions admin/build-doc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,24 @@ for bind in rados rbd cephfs rgw; do
fi
done

$vdir/bin/sphinx-build -a -n -b dirhtml -d doctrees $TOPDIR/doc $TOPDIR/build-doc/output/html
$vdir/bin/sphinx-build -a -b man -t man -d doctrees $TOPDIR/doc $TOPDIR/build-doc/output/man
if [ -z "$@" ]; then
sphinx_targets="html man"
else
sphinx_targets=$@
fi
for target in $sphinx_targets; do
builder=$target
case $target in
html)
builder=dirhtml
;;
man)
extra_opt="-t man"
;;
esac
$vdir/bin/sphinx-build -a -b $builder $extra_opt -d doctrees \
$TOPDIR/doc $TOPDIR/build-doc/output/$target
done

#
# Build and install JavaDocs
Expand Down
3 changes: 1 addition & 2 deletions doc/cephfs/client-config-ref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

``client acl type``

:Description: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to enable POSIX ACL, or an empty string. This option only takes effect when the
``fuse_default_permissions`` is set to ``false``.
:Description: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to enable POSIX ACL, or an empty string. This option only takes effect when the ``fuse_default_permissions`` is set to ``false``.

:Type: String
:Default: ``""`` (no ACL enforcement)
Expand Down
10 changes: 3 additions & 7 deletions doc/start/documenting-ceph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,17 +184,13 @@ To build the documentation, navigate to the ``ceph`` repository directory::

cd ceph

To build the documentation on Debian/Ubuntu, execute::
To build the documentation on Debian/Ubuntu, Fedora, or CentOS/RHEL, execute::

admin/build-doc

To build the documentation on Fedora, execute::
To scan for the reachablity of external links, execute::

admin/build-doc

To build the documentation on CentOS/RHEL, execute::

admin/build-doc
admin/build-doc linkcheck

Executing ``admin/build-doc`` will create a ``build-doc`` directory under ``ceph``.
You may need to create a directory under ``ceph/build-doc`` for output of Javadoc
Expand Down