Skip to content

Commit cf9ebe1

Browse files
tipatterson-devtipatterson-dev
committed
add main doc page and workflow
1 parent a8ac919 commit cf9ebe1

6 files changed

Lines changed: 160 additions & 1 deletion

File tree

‎.github/workflows/docs_pages.yaml‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Docs2Pages
2+
on:
3+
push:
4+
tags: '*'
5+
pull_request:
6+
branches:
7+
- master
8+
9+
jobs:
10+
build-docs:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@master
15+
with:
16+
fetch-depth: 0
17+
- uses: actions/setup-python@v2
18+
with:
19+
python-version: 3.9
20+
- uses: abatilo/actions-poetry@v2.1.3
21+
- name: install
22+
run: poetry install -E amazon -E docs
23+
- name: Build documentation
24+
run: |
25+
mkdir gh-pages
26+
touch gh-pages/.nojekyll
27+
cd docs/
28+
poetry run sphinx-build -b html . _build
29+
cp -r _build/* ../gh-pages/
30+
- name: Deploy documentation
31+
if: ${{ github.event_name == 'push' }}
32+
uses: JamesIves/github-pages-deploy-action@4.1.4
33+
with:
34+
branch: gh-pages
35+
folder: gh-pages

‎docs/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/source/conf.py‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'OSHConnect-Python'
10+
copyright = '2024, Ian Patterson'
11+
author = 'Ian Patterson'
12+
release = '0.1'
13+
14+
# -- General configuration ---------------------------------------------------
15+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16+
17+
18+
extensions = [
19+
'sphinx.ext.doctest',
20+
'sphinx.ext.duration',
21+
'sphinx.ext.autodoc',
22+
'sphinx.ext.autosummary',
23+
]
24+
templates_path = ['_templates']
25+
exclude_patterns = []
26+
27+
# -- Options for HTML output -------------------------------------------------
28+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
29+
30+
html_theme = 'alabaster'
31+
html_static_path = ['_static']

‎docs/source/index.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. OSHConnect-Python documentation master file, created by
2+
sphinx-quickstart on Tue Jun 25 11:43:33 2024.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to OSHConnect-Python's documentation!
7+
=============================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
14+
15+
Indices and tables
16+
==================
17+
18+
* :ref:`genindex`
19+
* :ref:`modindex`
20+
* :ref:`search`
21+
22+
23+
OSHConnect-Python
24+
=================
25+
OSHConnect-Python is the Python version of the OSHConnect family of application libraries inteded to provide a simple
26+
and straightforward way to interact with OpenSensorHub (or another CSAPI server) by way of OGC API - Connected Systems.
27+
It supports or will support at the time of a 1.0 release Part 1 and Part 2 of the Connected Systems api, as well as
28+
certain streaming features made possible by OpenSensorHub.
29+
30+
OSHConnect
31+
==========
32+
33+
.. automodule:: oshconnect
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

‎pyproject.toml‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ pydantic = "^2.7.4"
1313
shapely = "^2.0.4"
1414
websockets = "^12.0"
1515

16-
[tool.poetry.dev-dependencies]
16+
[tool.poetry.group.dev.dependencies]
1717
pytest = "^8.2.2"
18+
sphinx = "^7.3.7"
19+
flake8 = "^7.1.0"
1820

1921
[build-system]
2022
requires = ["poetry-core"]

0 commit comments

Comments
 (0)