Skip to content

add workflow for sphinx docs #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Manuel-Knepper wants to merge 9 commits into
base: main
Choose a base branch
from
Open

add workflow for sphinx docs #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8e9ea16
add workflow for sphinx docs
Manuel-Knepper Mar 26, 2026
b52d33d
Fix casing in module name for get_seed_points
Manuel-Knepper Mar 26, 2026
d36a91f
Fix capitalization in intersects_properly documentation
Manuel-Knepper Mar 26, 2026
4f974f7
Update module name to lowercase in documentation
Manuel-Knepper Mar 26, 2026
8926c75
Update module name to lowercase in documentation
Manuel-Knepper Mar 26, 2026
db8434f
Fix module name casing in API documentation
Manuel-Knepper Mar 26, 2026
717251c
Comment out growbikenet import in conf.py
Manuel-Knepper Mar 26, 2026
1767560
Comment out version and release in conf.py
Manuel-Knepper Mar 26, 2026
3ab88ab
Disable sphinxcontrib.bibtex extension
Manuel-Knepper Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/sphinx.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: "Sphinx: Render docs"

on: push

jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- name: Build HTML
uses: ammaraskar/sphinx-action@master
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
6 changes: 3 additions & 3 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. _api_ref:

.. automodule:: GrowBikeNet
.. automodule:: growbikenet
:members:
:undoc-members:

.. currentmodule:: GrowBikeNet
.. currentmodule:: growbikenet

GrowBikeNet API reference
==========================
Expand All @@ -21,4 +21,4 @@ GrowBikeNet does these things with these functions.
functions.intersects_properly
functions.get_seed_points
functions.node_to_edge_attributes
functions
functions
6 changes: 3 additions & 3 deletions docs/api/GrowBikeNet.functions.get_seed_points.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ο»ΏGrowBikeNet.functions.get\_seed\_points
ο»Ώgrowbikenet.functions.get\_seed\_points
=======================================

.. currentmodule:: GrowBikeNet.functions
.. currentmodule:: growbikenet.functions

.. autofunction:: get_seed_points
.. autofunction:: get_seed_points
6 changes: 3 additions & 3 deletions docs/api/GrowBikeNet.functions.intersects_properly.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ο»ΏGrowBikeNet.functions.intersects\_properly
ο»Ώgrowbikenet.functions.intersects\_properly
==========================================

.. currentmodule:: GrowBikeNet.functions
.. currentmodule:: growbikenet.functions

.. autofunction:: intersects_properly
.. autofunction:: intersects_properly
6 changes: 3 additions & 3 deletions docs/api/GrowBikeNet.functions.node_to_edge_attributes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ο»ΏGrowBikeNet.functions.node\_to\_edge\_attributes
ο»Ώgrowbikenet.functions.node\_to\_edge\_attributes
================================================

.. currentmodule:: GrowBikeNet.functions
.. currentmodule:: growbikenet.functions

.. autofunction:: node_to_edge_attributes
.. autofunction:: node_to_edge_attributes
6 changes: 3 additions & 3 deletions docs/api/GrowBikeNet.functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ο»ΏGrowBikeNet.functions
ο»Ώgrowbikenet.functions
=====================

.. automodule:: GrowBikeNet.functions
.. automodule:: growbikenet.functions


.. rubric:: Functions
Expand Down Expand Up @@ -30,4 +30,4 @@
MultiLineString
Point
combinations


10 changes: 5 additions & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@

import os
import sys
import growbikenet # noqa
#import growbikenet # noqa
# sys.path.insert(0, os.path.abspath("../"))

version = growbikenet.__version__
release = version
#version = growbikenet.__version__
#release = version

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
Expand All @@ -28,7 +28,7 @@
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.linkcode",
"sphinxcontrib.bibtex",
#"sphinxcontrib.bibtex",
"sphinx.ext.mathjax",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
Expand Down Expand Up @@ -115,4 +115,4 @@ def find_source():
except Exception:
filename = info["module"].replace(".", "/") + ".py"
tag = "main" if "+" in release else ("v" + release)
return f"https://github.com/BikeNetKit/GrowBikeNet/blob/{tag}/{filename}"
return f"https://github.com/BikeNetKit/GrowBikeNet/blob/{tag}/{filename}"
Loading