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

fix sphinx build warnings and errors #17025

Merged
merged 28 commits into from Aug 16, 2017
Merged

fix sphinx build warnings and errors #17025

merged 28 commits into from Aug 16, 2017

Conversation

alfredodeza
Copy link
Contributor

Currently there are a lot of broken links. Start fixing them one by one

@alfredodeza
Copy link
Contributor Author

jenkins test docs

@ceph-jenkins
Copy link
Collaborator

Doc build available at http://docs.ceph.com/ceph-prs/17025/

@alfredodeza alfredodeza force-pushed the wip-doc-warnings branch 2 times, most recently from 9e79dec to e428cf9 Compare August 14, 2017 21:55
@ceph-jenkins
Copy link
Collaborator

Doc build available at http://docs.ceph.com/ceph-prs/17025/

3 similar comments
@ceph-jenkins
Copy link
Collaborator

Doc build available at http://docs.ceph.com/ceph-prs/17025/

@ceph-jenkins
Copy link
Collaborator

Doc build available at http://docs.ceph.com/ceph-prs/17025/

@ceph-jenkins
Copy link
Collaborator

Doc build available at http://docs.ceph.com/ceph-prs/17025/

@alfredodeza
Copy link
Contributor Author

jenkins test docs

@ceph-jenkins
Copy link
Collaborator

Doc build available at http://docs.ceph.com/ceph-prs/17025/

amitkumar50
amitkumar50 suggested changes Aug 15, 2017
View reviewed changes
doc/dev/logging.rst
@@ -74,7 +74,7 @@ internal structures if they are the direct subject of the message,
for example in a corruption, but use plain english.
Example: instead of "Objecter requests" say "OSD client requests"
Example: it is okay to mention internal structure in the context
of "Corrupt session table" (but don't say "Corrupt SessionTable")
of "Corrupt session table" (but don't say "Corrupt SessionTable")
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe Let's use do not instead don't
Kindly see PR: #16705
Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not adding/changing the wording, just removing the indentation

@alfredodeza
Copy link
Contributor Author

jenkins test docs

@alfredodeza alfredodeza force-pushed the wip-doc-warnings branch 2 times, most recently from 72f3168 to ce23cbb Compare August 15, 2017 13:25
@ceph-jenkins
Copy link
Collaborator

make check succeeded

@alfredodeza alfredodeza force-pushed the wip-doc-warnings branch 4 times, most recently from 90e6047 to 8f7dcda Compare August 15, 2017 16:27
@alfredodeza
Copy link
Contributor Author

jenkins test docs

@alfredodeza alfredodeza changed the title [DNM} fix sphinx build warnings fix sphinx build warnings and errors Aug 15, 2017
@alfredodeza
Copy link
Contributor Author

This PR fixes all warnings and errors from Sphinx.

  • Bumps Sphinx to 1.6 to get rid of internal Python warnings from deprecated docutils
  • fixes broken references because documents moved but they were referenced with paths
  • makes Sphinx build with -W so that warnings are treated as errors, to prevent them from getting built/published
  • fixes some Python docstrings

@alfredodeza
Copy link
Contributor Author

jenkins test docs

1 similar comment
@alfredodeza
Copy link
Contributor Author

jenkins test docs

Alfredo Deza added 25 commits August 16, 2017 08:19
doc/logging fix unexpected indent in paragraph
640e080 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/api remove '*' in automethod call
e32f9be 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/radosgw fix missing newline on definition
e898eb7 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/radosgw add newline after field list
58a82d9 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations add newline after definition
e925b9f 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations add missing link for crush pdf
80f66e0 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
pybind: fix invalid doctring in Rados.require_state
9a247e1 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
pybind fix rbd trash_move docstring, needed a newline
89ace1b 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations include pg-repair document in the toctree
10e457f 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
admin: do not allow errors or warnings from doc build
d3543ef 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/cephfs add label to health messages for use in refs linking
d8b2870 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations add label for crush map tunables for ref linking
234c6a4 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations use the new ref label for crush map tunables
d8932d6 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
admin: bump sphinx to 1.6
88a1114 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/api/python document required_state manually
c7973cb 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations add ref label for placement group number
6c97013 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations use new ref label in health-checks
5a3da3a 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations add a ref label to pool application
aa90ea2 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations add a ref label to erasure code profiles
d6164f2 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/rados/operations use new ref labels in health-checks
3ec44df 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc/release-notes use new ref label for erasure code profiles
5c334d8 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc: exclude mgr from man pages, define a man index.rst
8e06659 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc: create an index/toctree only for man pages
e211924 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc exclude man_index when not building man pages
f78a991 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
doc: fix short underline on release-notes
457754e 
Signed-off-by: Alfredo Deza <adeza@redhat.com>
@alfredodeza
Copy link
Contributor Author

added a new fix for release-notes that just got in

@alfredodeza
Copy link
Contributor Author

jenkins test docs

@ceph-jenkins
Copy link
Collaborator

Doc build available at http://docs.ceph.com/ceph-prs/17025/

@alfredodeza alfredodeza merged commit 51ccc5f into master Aug 16, 2017
@alfredodeza alfredodeza deleted the wip-doc-warnings branch August 16, 2017 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmick dmick dmick approved these changes

@amitkumar50 amitkumar50 amitkumar50 requested changes

@andrewschoen andrewschoen andrewschoen approved these changes

@ktdreyer ktdreyer Awaiting requested review from ktdreyer

@johnwilkins johnwilkins Awaiting requested review from johnwilkins

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
5 participants
@alfredodeza @ceph-jenkins @dmick @andrewschoen @amitkumar50