Skip to content

Commit

Permalink
docs: Added edit button to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KennethEnevoldsen committed Aug 8, 2022
1 parent 2b07503 commit baf629b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
1 change: 1 addition & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -e .
- name: Build and Commit
uses: sphinx-notes/pages@v2
- name: Push changes
Expand Down
23 changes: 16 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, "..")
sys.path.insert(0, os.path.abspath("../"))


from spacy_wrap.about import __version__

Expand All @@ -25,6 +18,7 @@
project = "spacy-wrap"
author = "Kenneth Enevoldsen"

repo_url = f"https://github.com/kennethenevoldsen/{project}"
# The full version, including alpha/beta/rc tags
release = __version__

Expand Down Expand Up @@ -87,6 +81,21 @@
html_favicon = "_static/favicon.ico"

html_theme_options = {
"footer_icons": [
{
"name": "GitHub",
"url": repo_url,
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
</svg>
""",
"class": "",
},
],
"source_repository": repo_url,
"source_branch": "main",
"source_directory": "docs/",
"light_logo": "icon.png",
"dark_logo": "icon_dark.png",
"light_css_variables": {
Expand Down

1 comment on commit baf629b

@KennethEnevoldsen
Copy link
Owner

Choose a reason for hiding this comment

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

Coverage

Coverage Report
FileStmtsMissCoverMissing
spacy_wrap
   init.py30100% 
   architectures.py100100% 
   pipeline_component.py1102379%160, 173, 220–226, 239, 257–258, 294–312, 353–357, 367
   util.py38489%46–47, 59–64
spacy_wrap/layers
   init.py00100% 
   clf_transformer_model.py792667%90, 106–115, 120, 131–142, 170, 176–177, 185
   hf_classification_wrapper.py14286%67, 69
   hf_shim.py801285%74–78, 88–89, 113–116, 138
TOTAL3346780% 

Please sign in to comment.