Commit 3a2c895f authored by Spencer Williams's avatar Spencer Williams
Browse files

adds setup, testing for extensions

parent 4a715e08
---
image: rigado/docportal:latest
stages:
- test
test_job:
stage: test
tags:
- docker
script:
. /scripts/test.sh
This document is **not** an example to follow for how to use the theme and extensions here.
This document is a way to test the features of the theme and extensions without first publishing them to PyPI.
For an example on how these packages are used, see an external document, such as `Cascade Docs <https://git.rigado.com/documentation/cascade-docs>`__.
../../../extensions/sphinxcontrib/rigado/
\ No newline at end of file
......@@ -31,7 +31,10 @@ release = ''
# -- General configuration ---------------------------------------------------
import sys, os
sys.path.append(os.path.abspath('_extensions/rigado'))
extensions = [
'inventory-builder'
]
templates_path = ['_templates']
source_suffix = '.rst'
......
Copyright 2018 Rigado
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
************************
Rigado Sphinx Extensions
************************
- ``inventory-builder``: A shorter version of the HTML builder, that only outputs an inventory (e.g. for use with ``intersphinx``)
- ``tablelist``: Adds ``tablelist`` and ``figurelist`` directives to compile lists of tables and figures, respectively.
#!/usr/bin/env python
from io import open
from setuptools import setup
from sphinxcontrib.rigado import __version__
setup(
name='sphinxcontrib-rigado',
version=__version__,
author='Spencer Williams',
author_email='spencer.williams@rigado.com',
description='Sphinx extensions for Rigado',
long_description=open('README.rst', encoding='utf-8').read(),
url='https://git.rigado.com/documentation/sphinx',
license='MIT',
packages=['sphinxcontrib.rigado'],
include_package_data=True,
)
#!/usr/bin/env bash
set -e
cd example
# -n makes more warnings happen
# -W makes warnings into errors
# inventory just builds the inventory. it's the fastest builder.
make SPHINXOPTS='-n -W' clean inventory
......@@ -11,7 +11,7 @@ setup(
author_email='spencer.williams@rigado.com',
description='A Sphinx theme for Rigado',
long_description=open('README.rst', encoding='utf-8').read(),
url='https://git.rigado.com/documentation/sphinx-rigado-theme',
url='https://git.rigado.com/documentation/sphinx',
license='MIT',
packages=['sphinx_rigado_theme'],
package_data={'sphinx_rigado_theme': [
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment