Skip to content

Commit

Permalink
Use Markdown link to target in notebook
Browse files Browse the repository at this point in the history
- was blocked by myst-nb
- upgrade docs dependencies
  • Loading branch information
yuanx749 committed Nov 12, 2023
1 parent bde98f1 commit 1b6b7d8
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 12 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/sphinx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.8'
python-version: '3.10'
cache: 'pip'
cache-dependency-path: pyproject.toml
- name: Install dependencies
Expand All @@ -22,7 +22,7 @@ jobs:
run: make html
working-directory: docs
- name: Upload artifacts
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v2
with:
path: docs/_build/html/

Expand All @@ -38,4 +38,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v2
4 changes: 2 additions & 2 deletions docs/examples/examples.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"metadata": {},
"source": [
"## Higher level interface\n",
"Work on `DataFrame` using classes."
"Work on [DataFrame](#pandas.DataFrame) using classes."
]
},
{
Expand All @@ -41,7 +41,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Read a fasta file as a `DataFrame` containing some amino acid sequences."
"Read a fasta file as a [DataFrame](#pandas.DataFrame) containing some amino acid sequences."
]
},
{
Expand Down
35 changes: 35 additions & 0 deletions docs/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)

if "%1" == "" goto help

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

:end
popd
2 changes: 1 addition & 1 deletion pycdhit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from ._commands import * # noqa: F403
from ._io import * # noqa: F403

VERSION = "0.5.0"
VERSION = "0.6.0"

__all__ = [ # noqa: F405
"CommandBase",
Expand Down
10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ dev = [
"pytest-cov>=4.0.0",
]
doc = [
"sphinx==5.3.0",
"furo==2022.12.7",
"myst-nb==0.17.1",
"myst-parser==0.18.1",
"sphinx-copybutton==0.5.1",
"sphinx==7.2.6",
"furo==2023.9.10",
"myst-nb==1.0.0",
"myst-parser==2.0.0",
"sphinx-copybutton==0.5.2",
"notebook>=6.5.4",
]

Expand Down

0 comments on commit 1b6b7d8

Please sign in to comment.