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.

Sign up for GitHub

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

Jump to bottom

docs: Use toctree glob for ip/project_based #153

Merged
merged 1 commit into from
Jan 10, 2025
Merged

docs: Use toctree glob for ip/project_based #153

merged 1 commit into from
Jan 10, 2025

Conversation

gastmaier
Copy link
Contributor

PR Description

Most merge conflicts are just the inclusion at the toctree in alphabetical order, by using glob, we can mitigate them. To not include the orphan templates, rename them to _index.

Also remove dangling orphan empty project ad7616.

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • New test (change that adds new test program and/or testbench)
  • Breaking change (has dependencies in other repositories/testbenches)

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have ran all testbenches affected by this PR
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Errors on compilation/elaboration/simulation
  • I have set the verbosity level to none for the test program

@gastmaier
docs: Use toctree glob for ip/project_based
7108ee6 
Most merge conflicts are just the inclusion at the toctree in
alphabetical order, by using glob, we can mitigate them.
To not include the orphan templates, rename them to _index.

Also remove dangling orphan empty project ad7616.

Signed-off-by: Jorge Marques <[email protected]>
@gastmaier gastmaier mentioned this pull request Jan 9, 2025
Merged
12 tasks
@gastmaier gastmaier merged commit fdda4ef into main Jan 10, 2025
2 checks passed
@gastmaier gastmaier deleted the doc-glob-ip-proj branch January 10, 2025 08:02
@IstvanZsSzekely IstvanZsSzekely added the documentation Improvements or additions to documentation label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@IstvanZsSzekely IstvanZsSzekely IstvanZsSzekely approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gastmaier @IstvanZsSzekely