10000 YT-CPPAP-41: Documentation deployment refinement by SpectraL519 · Pull Request #75 · SpectraL519/cpp-ap · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
8000

YT-CPPAP-41: Documentation deployment refinement #75

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
Merged
merged 7 commits into from
Jul 4, 2025
Merged

YT-CPPAP-41: Documentation deployment refinement #75

merged 7 commits into from
Jul 4, 2025

Conversation

SpectraL519
Copy link
Owner
  • Added the documentation postprocessing script, which:
    • fixes the markdown file links, GFM-style callouts, heading code blocks
    • removes the mainpage title generated by doxygen
  • Aligned the documentation workflow to:
    • validate that the current cmake and doxygen version matches the created tag
    • apply the postprocessing step to the generated documentation
    • upload the current version to the latest directory as well as to the directory if the current tag is actually the latest
  • Aligned the docs to include the proper explanation of how to generate and browse the documentation
  • Aligned the indentation in docs so that they are properly handeled by doxygen
  • Added the repository link to the docomuentation main page (readme)

SpectraL519 and others added 7 commits July 2, 2025 16:25
@SpectraL519
YT-CPPAP-41: Documentation deployment refinement
38899eb 
- Added a documentation postprocessing script for md reference and GFM-style callouts fixing
- Aligned the documentation workflow to:
  - verify that the project version is the same as the version tag
  - apply the postprocessing step to the generated documentation before uploading it to gh-pages
  - upload the current version to the latest directory in addition to the <version> directory if the current tag is actually the latest
- Aligned the docs to include the proper explanation of how to access the documentation or build it locally with postprocessing
- Add the repository link to the README (main page of the documentation)
@SpectraL519
removing the header div from index.html in postprocessing
1732130
@SpectraL519
enlarged and centered the github icon in readme
ec10eb8
@SpectraL519
sandboxing
17b17d9
@SpectraL519
fixed indentation in the tutorial.md file
405616a
@SpectraL519
aligned the predefined arg values section
2851310
@SpectraL519
heading code block handling
ca1f748
SpectraL519
SpectraL519 commented Jul 4, 2025
View reviewed changes
Copy link
Owner Author
@SpectraL519 SpectraL519 left a comment

Choose a reason for hiding this comment

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

ok

@SpectraL519 SpectraL519 merged commit 051b692 into master Jul 4, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@SpectraL519
0