📝 Initialize Documentation on ReadTheDocs #98
Merged
Conversation
This file contains 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
Signed-off-by: burgholzer <burgholzer@me.com>
Codecov Report
@@ Coverage Diff @@
## main #98 +/- ##
=====================================
Coverage 91.1% 91.1%
=====================================
Files 20 20
Lines 1726 1726
Branches 411 411
=====================================
Hits 1573 1573
Misses 153 153 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
burgholzer
added a commit
that referenced
this pull request
Sep 5, 2022
Now that the foundation has been laid in #98, it is time to get things to work properly. Of course, the build failed right away because no proper version of Z3 was available for the documentation build. This PR fixes these build errors by updating the Ubuntu image used to build the docs. The updated image (Ubuntu-22.04) comes with a recent enough z3 version to build QMAP. Signed-off-by: burgholzer <burgholzer@me.com>
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 PR adds the initial configuration and infrastructure for building proper project documentation on ReadTheDocs.
Building the documentation locally is as easy as
nox -rs docs -- serveAt the moment the documentation is pretty much empty. Filling it with content will be done in a separate PR.