Skip to content

remove unused tutorials in documentation and fix doc build warning (infra)#948

Merged
kissiel merged 1 commit intomainfrom
fix-doc-orphan-pages
Jan 18, 2024
Merged

remove unused tutorials in documentation and fix doc build warning (infra)#948
kissiel merged 1 commit intomainfrom
fix-doc-orphan-pages

Conversation

@tang-mm
Copy link
Copy Markdown
Collaborator

@tang-mm tang-mm commented Jan 18, 2024

Description

  • removed unused tutorials: tutorial.rst and test-output.rst. Both docs are replaced by newer tutorials and no longer referenced by any other file, but the existance of source files cause versioning issues in doc build (see Jira issue description)
  • fixed warning in doc build "document isn't included in any toctree" by adding hidden toc directive

Resolved issues

CHECKBOX-1069
(and warning on the v2.8 tutorial page )

Documentation

preview: https://canonical-checkbox--948.com.readthedocs.build/en/948/

Tests

To preview docs locally, in the docs/ folder, run make install and then make run

Copy link
Copy Markdown
Contributor

@kissiel kissiel left a comment

Choose a reason for hiding this comment

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

TYVM! +1

@kissiel kissiel merged commit c2f14fa into main Jan 18, 2024
@kissiel kissiel deleted the fix-doc-orphan-pages branch January 18, 2024 12:12
LiaoU3 pushed a commit to LiaoU3/checkbox that referenced this pull request Mar 20, 2024
…nfra) (canonical#948)

doc: remove outdated pages and fix toc warning
binli pushed a commit to binli/checkbox that referenced this pull request Mar 22, 2024
…nfra) (canonical#948)

doc: remove outdated pages and fix toc warning
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants