Skip to content

Commit

Permalink
Add placeholder for documentation and readthedocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaine committed May 16, 2024
1 parent a553cc8 commit ad01c06
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.10"
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
include ChangeLog LICENSE README.rst
include Makefile

graft docs
graft src
graft tests

exclude .readthedocs.yaml
global-exclude *.py[cod] __pycache__ .*.sw[po]
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
25 changes: 25 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'sipmessage'
copyright = '2024, Spacinov Engineering'
author = 'Spacinov Engineering'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = ['_static']
16 changes: 16 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
sipmessage
==========

.. image:: https://img.shields.io/pypi/l/sipmessage.svg
:target: https://pypi.python.org/pypi/sipmessage
:alt: License

.. image:: https://img.shields.io/pypi/v/sipmessage.svg
:target: https://pypi.python.org/pypi/sipmessage
:alt: Version

The ``sipmessage`` project provides a set of Python helpers and structures
for parsing SIP messages.

.. toctree::
:maxdepth: 2

0 comments on commit ad01c06

Please sign in to comment.