Project

Profile

Help

Issue #7090

Pulpcore docs have issues

Added by daviddavis about 1 month ago. Updated 2 days ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Sprint 79

Description

Using rstcheck[0], I found a number of issues in our pulpcore docs:

❯ rstcheck --ignore-directives sphinx,automodule,autoclass,autofunction **/*.rst        
CHANGES.rst:3: (INFO/1) Duplicate explicit target name: "#6484".
docs/bugs-features.rst:83: (INFO/1) Duplicate implicit target name: "triage".
docs/changes.rst:1: (INFO/1) Hyperlink target "pulpcore-changes" is not referenced.
docs/components.rst:4: (INFO/1) Hyperlink target "deployment" is not referenced.
docs/contributing/architecture/error-handling.rst:1: (INFO/1) Hyperlink target "error-handling" is not referenced.
docs/contributing/architecture/rest-api.rst:386: (ERROR/3) (python) expected an indented block
docs/contributing/dev-setup.rst:1: (INFO/1) Hyperlink target "devsetup" is not referenced.
docs/contributing/git.rst:90: (WARNING/2) malformed hyperlink target.
docs/contributing/style-guide.rst:16: (INFO/1) Duplicate implicit target name: "pep-8".
docs/contributing/tests.rst:1: (INFO/1) Hyperlink target "istqb" is not referenced.
docs/index.rst:9: (INFO/1) Hyperlink target "community" is not referenced.
docs/installation/authentication.rst:4: (INFO/1) Duplicate implicit target name: "basic authentication".
docs/installation/configuration.rst:4: (INFO/1) Duplicate implicit target name: "configuration".
docs/installation/index.rst:4: (INFO/1) Duplicate implicit target name: "installation".
docs/installation/instructions.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
docs/installation/storage.rst:4: (INFO/1) Duplicate implicit target name: "storage".
docs/plugins/api-reference/content-app.rst:1: (INFO/1) Hyperlink target "content-app-docs" is not referenced.
docs/plugins/api-reference/download.rst:1: (INFO/1) Hyperlink target "download-docs" is not referenced.
docs/plugins/api-reference/profiling.rst:27: (INFO/1) No directive entry for "automethod" in module "docutils.parsers.rst.languages.en".
docs/plugins/api-reference/stages.rst:1: (INFO/1) Hyperlink target "stages-api-docs" is not referenced.
docs/plugins/api-reference/storage.rst:1: (INFO/1) Hyperlink target "storage-docs" is not referenced.
docs/plugins/index.rst:19: (INFO/1) Duplicate implicit target name: "plugin api".
docs/plugins/plugin-writer/concepts/index.rst:1: (INFO/1) Hyperlink target "plugin-concepts" is not referenced.
docs/plugins/plugin-writer/concepts/subclassing/import-export.rst:1: (INFO/1) Hyperlink target "subclassing-import-export" is not referenced.
docs/plugins/plugin-writer/concepts/subclassing/models.rst:1: (INFO/1) Hyperlink target "subclassing-models" is not referenced.
docs/plugins/plugin-writer/concepts/subclassing/serializers.rst:1: (INFO/1) Hyperlink target "subclassing-serializers" is not referenced.
docs/plugins/plugin-writer/concepts/subclassing/viewsets.rst:1: (INFO/1) Hyperlink target "subclassing-viewsets" is not referenced.
docs/plugins/plugin-writer/concepts/sync_pipeline/sync_pipeline.rst:1: (INFO/1) Hyperlink target "stages-concept-docs" is not referenced.
docs/plugins/plugin-writer/concepts/tasks/add-remove.rst:33: (INFO/1) Hyperlink target "sync-docs" is not referenced.
docs/plugins/plugin-writer/planning-guide.rst:1: (INFO/1) Hyperlink target "planning-guide" is not referenced.
docs/plugins/plugin-writer/plugin-walkthrough.rst:15: (INFO/1) Hyperlink target "define-content-type" is not referenced.
docs/plugins/reference/content-protection.rst:1: (INFO/1) Hyperlink target "content-protection" is not referenced.
docs/plugins/reference/error-handling.rst:1: (INFO/1) Hyperlink target "error-handling-basics" is not referenced.
docs/plugins/reference/how-plugins-work.rst:4: (INFO/1) Hyperlink target "plugin-django-application" is not referenced.
docs/plugins/reference/metadata-signing.rst:1: (INFO/1) Hyperlink target "metadata-signing" is not referenced.
docs/plugins/reference/object-relationships.rst:1: (INFO/1) Hyperlink target "object-relationships" is not referenced.
docs/plugins/reference/on-demand-support.rst:1: (INFO/1) Hyperlink target "on-demand-support" is not referenced.
docs/settings.rst:4: (INFO/1) Duplicate implicit target name: "settings".
docs/versioning.rst:4: (INFO/1) Duplicate implicit target name: "versioning".
docs/workflows/import-export.rst:2: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
docs/workflows/repairing-repository-versions.rst:1: (INFO/1) Hyperlink target "repository-version-repairing" is not referenced.
docs/workflows/signed-metadata.rst:1: (INFO/1) Hyperlink target "configuring-signing" is not referenced.
HISTORY.rst:2: (INFO/1) Duplicate explicit target name: "pulp_file".

[0] https://github.com/myint/rstcheck


Related issues

Related to Pulp - Task #7091: Add rstcheck to plugin templateNEW

<a title="Actions" class="icon-only icon-actions js-contextmenu" href="#">Actions</a>

History

#1 Updated by daviddavis about 1 month ago

  • Tags Documentation added

#2 Updated by daviddavis about 1 month ago

  • Related to Task #7091: Add rstcheck to plugin template added

#3 Updated by fao89 about 1 month ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 76

#4 Updated by rchan about 1 month ago

  • Sprint changed from Sprint 76 to Sprint 77

#5 Updated by rchan 13 days ago

  • Sprint changed from Sprint 77 to Sprint 78

#6 Updated by rchan 2 days ago

  • Sprint changed from Sprint 78 to Sprint 79

Please register to edit this issue

Also available in: Atom PDF