[PR #2136] [MERGED] Exclude irrelevant files from mkdocs rendering #2521

Closed
opened 2025-12-29 03:21:38 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2136
Author: @nblock
Created: 9/15/2024
Status: Merged
Merged: 9/16/2024
Merged by: @kradalby

Base: mainHead: exclude


📝 Commits (1)

  • 87b749e Exclude irrelevant files from mkdocs rendering

📊 Changes

1 file changed (+7 additions, -0 deletions)

View changed files

📝 mkdocs.yml (+7 -0)

📄 Description

Files are otherwise copied as-is to the site/ directory and get published along with the documentation.

Ref: https://www.mkdocs.org/user-guide/configuration/#exclude_docs


  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

Summary by CodeRabbit

  • New Features
    • Introduced an exclude_docs configuration in the documentation settings to omit specific files from the generated documentation, enhancing clarity and focus on relevant content.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/juanfont/headscale/pull/2136 **Author:** [@nblock](https://github.com/nblock) **Created:** 9/15/2024 **Status:** ✅ Merged **Merged:** 9/16/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `exclude` --- ### 📝 Commits (1) - [`87b749e`](https://github.com/juanfont/headscale/commit/87b749e1a6b184f9da8340e403d6d6247d8c3040) Exclude irrelevant files from mkdocs rendering ### 📊 Changes **1 file changed** (+7 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `mkdocs.yml` (+7 -0) </details> ### 📄 Description Files are otherwise copied as-is to the `site/` directory and get published along with the documentation. Ref: https://www.mkdocs.org/user-guide/configuration/#exclude_docs --- - [x] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [ ] raised a GitHub issue or discussed it on the projects chat beforehand - [ ] added unit tests - [ ] added integration tests - [x] updated documentation if needed - [ ] updated CHANGELOG.md <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced an `exclude_docs` configuration in the documentation settings to omit specific files from the generated documentation, enhancing clarity and focus on relevant content. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 03:21:38 +01:00
adam closed this issue 2025-12-29 03:21:38 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2521