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

Reference docs for removed commands persist between builds #5200

Open
medubelko opened this issue Jan 9, 2025 · 2 comments
Open

Reference docs for removed commands persist between builds #5200

medubelko opened this issue Jan 9, 2025 · 2 comments
Labels
bug Actual bad behavior that don't fall into maintenance or documentation triaged

Comments

@medubelko
Copy link
Contributor

medubelko commented Jan 9, 2025

Bug Description

Auto-generated pages for command references aren't tracked in Git or checked by gen_cli_docs.py.

I suggest we have the script check the list of command pages against the list of enabled commands, and remove any that are obsolete.

To Reproduce

  1. Checkout Snapcraft 8.5.1 or earlier.
  2. Build the docs.
  3. Checkout the latest Snapcraft.
  4. Build the docs.

The second build fails because the references for the outdated commands (disabled in #5195) are present and unindexed.

Relevant log output

Warning, treated as error:
/home/med/dev/snapcraft/docs/reference/commands/edit-registries.rst:document isn't included in any toctree
@medubelko medubelko added bug Actual bad behavior that don't fall into maintenance or documentation triaged labels Jan 9, 2025
Copy link

Thank you for reporting your feedback to us!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3884.

This message was autogenerated

Copy link

Thank you for reporting your feedback to us!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3885.

This message was autogenerated

@medubelko medubelko changed the title References for removed commands persist between builds Reference docs for removed commands persist between builds Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Actual bad behavior that don't fall into maintenance or documentation triaged
Projects
None yet
Development

No branches or pull requests

1 participant