Open eddiebergman opened 8 months ago
Merging #101 (1682f66) into master (ea3a212) will decrease coverage by
0.05%
. The diff coverage isn/a
.
@@ Coverage Diff @@
## master #101 +/- ##
==========================================
- Coverage 67.79% 67.75% -0.05%
==========================================
Files 37 37
Lines 7225 7225
==========================================
- Hits 4898 4895 -3
- Misses 2327 2330 +3
see 1 file with indirect coverage changes
:mega: Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!
Hi Ysig,
I can't be certain that this github action will work out of the box and I will likely need to do some live debugging with respect to actions deploying to gh-pages. I can test this by deploying this actual branch
doc-ci
to gh-pages and seeing if it all worksSome points not tackled by this PR:
gh-pages
branch seems to have several version there although on the live published docs, there's no way to choose between them. You can however manually enter it in the url.There is an
index.html
in thegh-pages
branch which points to a specific version, i.e."0.1a8"
, however I do not know how to update this automatically (either by the gh-actions or even how to identify which version is latest)The file looks like this
My proposal is that every time there is a push to master, it deploys the docs to
latest
and theindex.html
to be updated to reflect this, i.e.You can see this in the workflow file
Other points
doc
which is installable withpip install -e ".[doc]"
MutableSet
fromcollections
MultiscaleLaplacianFast
from the docs as I found a changelog entry saying it was removed and replaced withMultiscaleLaplacian
.pynauty
. I could not find a documentation page for it so I do not know how to update this link or whether such a link exists. Normally I would play around with links at published docs but it seempynauty
does not have live docs.KKMMN2016
doctest
seems to be running any doctests present in imported scipy modules, some of which are failing (despite them seeming correct). All of GraKels doctests seem fine. This doesn't stop GraKel's documentation from building itself but it does produce errors which CI system will pick up on and likely fail (since they think the whole doc bulding failed) 1. One option is just don'tdoctest
for the doc release (implemented) 2. Do thedoctest
but ignore errors. 2. Lastly, fix it. However I couldn't figure it out https://www.sphinx-doc.org/en/master/usage/extensions/doctest.htmlWritten inside
.github/workflows/doc.yaml