Open
Conversation
Member
Author
|
CI docs build works fine, the artifact is available at https://github.com/QuantStack/git2cpp/actions/runs/22581867209/artifacts/5723460686. The ReadTheDocs setup will take longer to set up, presumably it needs some appropriate permission. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #110 +/- ##
=======================================
Coverage 86.83% 86.83%
=======================================
Files 60 60
Lines 2340 2340
Branches 276 276
=======================================
Hits 2032 2032
Misses 308 308 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
12237ee to
1c46b1a
Compare
Member
Author
|
Read the Docs build succeeded, it is at https://git2cpp--110.org.readthedocs.build/en/110/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds
sphinxdocumentation for the project, most of which is generated from the command and subcommand help by a python scriptcreate_markdown.pythat runs at the start of the doc build process to generate the.mdfiles that are used as input tosphinx. Fixes #72.There is a separate help page for each subcommand, and there are links to the child subcommand help pages from the parent. Here is a screencast of the results of a local build:
git2cpp-docs.mp4
I have added a CI run to build the docs and upload an artifact so that we can manually check if the results are OK, and I've also added a Read the Docs config file with the intention of uploading there so that we have support for different build versions of the docs.
At this stage I am not looking for the output to be perfect, I just want to get the infrastructure in place so that we can improve the individual subcommand help and the appearance of the doc website.