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

Complete moving the docs to docs.pulpproject.org #245

Merged
merged 1 commit into from Jan 19, 2021
Merged

Conversation

quba42
Copy link
Collaborator

@quba42 quba42 commented Jan 19, 2021

@pulpbot
Copy link
Member

pulpbot commented Jan 19, 2021

Attached issue: https://pulp.plan.io/issues/8113

.gitignore Show resolved Hide resolved
@quba42
Copy link
Collaborator Author

quba42 commented Jan 19, 2021

I will wait for final confirmation by @dkliban that docs/_static/ap.json is not needed in source.
However, from what I see in .ci/scripts/docs-builder.py it looks like this is generated on the fly by the build pipeline.

@quba42 quba42 changed the title Change all plugin documentation URLs Complete moving the docs to docs.pulpproject.org Jan 19, 2021
@quba42 quba42 added the .doc CHANGES/<issue_number>.doc label Jan 19, 2021

You will also have a built version of this documentation at ``docs/_build/html/index.html``.
You can open this locally built documentation in a browser, but you will not be able to view the API docs, since those make use of an external service, that obviously has no access to your local build.
You can open the locally built documentation in a browser, but you will not be able to view the API docs, since those make use of an external service, that obviously has no access to your local build.
Copy link
Member

Choose a reason for hiding this comment

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

How so?

Copy link
Collaborator Author

@quba42 quba42 Jan 19, 2021

Choose a reason for hiding this comment

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

My analysis of the reason why this fails could be wrong, but I get the following trying to view locally built API docs:
local_api_docs

The file mentioned in the error is locally present.

Copy link
Member

Choose a reason for hiding this comment

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

right

@quba42 quba42 merged commit b691659 into pulp:main Jan 19, 2021
@quba42 quba42 deleted the docs_move branch January 19, 2021 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
.doc CHANGES/<issue_number>.doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants