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

fix warnings in docs builds #273

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
2 participants
@anarcat
Contributor

anarcat commented Oct 4, 2018

A clean build of the docs yielded the following errors:

reading sources... [100%] updates                                               
/home/anarcat/src/internetarchive/docs/source/jq.rst:4: WARNING: Duplicate explicit target name: "jq".
/home/anarcat/src/internetarchive/docs/source/jq.rst:229: WARNING: Title level inconsistent:

TODO
____
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/anarcat/src/internetarchive/docs/source/jq.rst: WARNING: document isn't included in any toctree
/home/anarcat/src/internetarchive/docs/source/metadata.rst: WARNING: document isn't included in any toctree

This patch adds the missing documents to the toctree and fixes the todo title.

@jjjake

This comment has been minimized.

Show comment
Hide comment
@jjjake

jjjake Oct 4, 2018

Owner

metadata.rst should be deleted. Those docs have moved to https://archive.org/services/docs/api/metadata-schema/index.html (i.e. they will no longer be a part of the internetarchive library/CLI documentation). BTW, we're in the process of transitioning from reathedocs.io to https://archive.org/services/docs/api/internetarchive/docs/source/index.html (I'll put a redirect in place when we're ready. There's still a bit of work to do, e.g. automating the build process, etc.).

jq.rst can be added (This was a first pass at documenting the use of jq with ia, but it looks good to me. I'll continue to work on it.).

If you'd prefer I make the changes just let me know, otherwise feel free to delete metadata.rst from the TOC as well as the file and I'll merge the PR.

Thanks again!

Owner

jjjake commented Oct 4, 2018

metadata.rst should be deleted. Those docs have moved to https://archive.org/services/docs/api/metadata-schema/index.html (i.e. they will no longer be a part of the internetarchive library/CLI documentation). BTW, we're in the process of transitioning from reathedocs.io to https://archive.org/services/docs/api/internetarchive/docs/source/index.html (I'll put a redirect in place when we're ready. There's still a bit of work to do, e.g. automating the build process, etc.).

jq.rst can be added (This was a first pass at documenting the use of jq with ia, but it looks good to me. I'll continue to work on it.).

If you'd prefer I make the changes just let me know, otherwise feel free to delete metadata.rst from the TOC as well as the file and I'll merge the PR.

Thanks again!

@anarcat

This comment has been minimized.

Show comment
Hide comment
@anarcat

anarcat Oct 4, 2018

Contributor

If you'd prefer I make the changes just let me know, otherwise feel free to delete metadata.rst from the TOC as well as the file and I'll merge the PR.

Please do go ahead. :) But I think there should be some cross-refs to some metadata docs in the cli page at least and i liked how it was simple and clearly stated... the metadata schema isn't as well-formatted, from what i can tell.

Contributor

anarcat commented Oct 4, 2018

If you'd prefer I make the changes just let me know, otherwise feel free to delete metadata.rst from the TOC as well as the file and I'll merge the PR.

Please do go ahead. :) But I think there should be some cross-refs to some metadata docs in the cli page at least and i liked how it was simple and clearly stated... the metadata schema isn't as well-formatted, from what i can tell.

@anarcat anarcat closed this Oct 4, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment