ysig / GraKeL

A scikit-learn compatible library for graph kernels
https://ysig.github.io/GraKeL/
Other
587 stars 96 forks source link

build: Add doc dependancies #101

Open eddiebergman opened 8 months ago

eddiebergman commented 8 months ago

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 works

Some points not tackled by this PR:


Other points

WARNING: failed to reach any of the inventories with the following issues: intersphinx inventory 'https://web.cs.dal.ca/~peter/software/pynauty/html/objects.inv' not fetchable due to <class 'requests.exceptions.HTTPError'>: 404 Client Error: Not Found for url: https://web.cs.dal.ca/~peter/software/pynauty/html/objects.inv

/home/skantify/code/GraKeL/doc/documentation/introduction.rst:203: WARNING: Could not lex literal_block 'edges = {1: [2, 3], 2: [1], 3: [1]}\nnode_attributes = {1: [1.2, 0.5], 2: [2.8, −0.6], 3: [0.7, 1.1]}\nG = Graph(edges, node_labels=node_attributes)' as "python". Highlighting skipped.


Written inside .github/workflows/doc.yaml

# If triggered on the master branch, then it will be pushed to the `latest` directory
# of `gh-pages`, which will be the default landing page. If this is triggered on any other
# branch, it will take the name of the branch and use it a directory name (i.e. version branch).
# This will allow us to have a landing page for each version of GraKeL.
#
# Workflow:
#   * Update `latest` by pushing to master
#   * New vesrion by manually dispatching this on a new branch
#
# Something went wrong, I need to manually inspect:
#   * git clone git@github.com/ysig/GraKeL.git
#   * git checkout gh-pages
#   * Poke around, modify as needed
#   * git add .
#   * git commit -m "Update gh-pages"
#   * git push origin gh-pages
#   * wait until GitHub deploys the changes
codecov[bot] commented 8 months ago

Codecov Report

Merging #101 (1682f66) into master (ea3a212) will decrease coverage by 0.05%. The diff coverage is n/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!