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.

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

doc: fixes to silence sphinx-build #13997

Merged
merged 11 commits into from Mar 21, 2017

Conversation

Projects
None yet
2 participants
@tchaikov
Copy link
Contributor

tchaikov commented Mar 16, 2017

No description provided.

tchaikov added some commits Mar 16, 2017

doc/dev/osd_internals: fix sphinx warnings
silences errors like

erasure_coding/proposals.rst:236: ERROR: Unexpected indentation.

Signed-off-by: Kefu Chai <kchai@redhat.com>
docs/cephfs: troubleshooting.rst: fix sphinx warning
silences following warning:

troubleshooting.rst:16: WARNING: unknown document:
/rados/troubleshooting

Signed-off-by: Kefu Chai <kchai@redhat.com>

@tchaikov tchaikov changed the title doc: fixings to silence sphinx-build doc: fixes to silence sphinx-build Mar 16, 2017

tchaikov added some commits Mar 16, 2017

docs/radosgw: fix sphinx warning
* upgrade_to_jewel.rst: silence following warning
  upgrade_to_jewel.rst:1: WARNING: Title overline too short.
* index.rst: add links to not-included docs
  add api.rst, layout.rst and upgrade_to_jewel.rst to toc
  silences warning like
  api.rst:: WARNING: document isn't included in any toctree

Signed-off-by: Kefu Chai <kchai@redhat.com>
docs/dev: fix sphinx warning
silence following error

radosgw/s3_compliance.rst:34: ERROR: Malformed table.

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/dev/osd_internals: fix sphinx warnings
silence following warnings:

erasure_coding.rst:77: WARNING: toctree contains reference to
nonexisting document u'dev/osd_internals/erasure_coding/pgbackend'

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/rados: fix sphinx warning
silences follow warning:

network-config-ref.rst:373: WARNING: Field list ends without a blank line; unexpected unindent.

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/cephfs: add capabilities.rst to toc
Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/dev/index: fix sphinx warnings
- index.rst:822: ERROR: Unknown target name: "teuthology-suite".
  add a ref to teuthology doc
- index.rst:3: WARNING: Duplicate explicit target name: "here".
  use "Named hyperlink references" instead of "anonymous hyperlink
  references"

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc: add :orphan: to orphaned docs
we should remove the deprecated ones once it's safe to remove them.

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc: indent :maxdepth: using spaces in toc
* indent :maxdepth: directive properly, otherwise sphinx complains
   index.rst:45: WARNING: toctree contains reference to nonexisting
   document u'rados/configuration/    :maxdepth: 1'
* also reindent the entries in toc, so we can add paths without
  documenting their titles. because otherwise the paths inclues an extra
  space, without the proper indent.

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/glossary: add "Ceph Manager" and "OSD Daemons" to glossary
Signed-off-by: Kefu Chai <kchai@redhat.com>

@tchaikov tchaikov force-pushed the tchaikov:wip-doc-fixings branch from 289eba8 to 75fa762 Mar 16, 2017

@badone

badone approved these changes Mar 21, 2017

Copy link
Contributor

badone left a comment

LGTM

@tchaikov tchaikov merged commit b935248 into ceph:master Mar 21, 2017

3 checks passed

Signed-off-by all commits in this PR are signed
Details
Unmodifed Submodules submodules for project are unmodified
Details
default Build finished.
Details

@tchaikov tchaikov deleted the tchaikov:wip-doc-fixings branch Mar 21, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.