Commit e73e95c1 authored by Spencer Williams's avatar Spencer Williams
Browse files

Merge branch 'pip' into 'master'

reorganize repo as python projects

See merge request documentation/sphinx!1
parents 47365304 bc994ce7
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
*/dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
---
image: rigado/docportal:latest
stages:
- test
test_job:
stage: test
tags:
- docker
script:
- ./scripts/test.sh
# Rigado Sphinx Themes and Extensions
Include this repository as a submodule of your Sphinx project repository, then wire it up to use its themes and extensions!
Other repositories that require this one:
- documentation/ditto
- documentation/style-guide
- documentation/cascade-docs
- documentation/cascade-cli
- documentation/rtd-portal
See READMEs in subdirectories
[theme]
inherit = classic
stylesheets = rigado.css
pygments_style = none
[options]
analytics_ua =
analytics_domain =
use_search = True
use_global_toc =
\usepackage{lastpage} % for "page n of m" feature
\usepackage{pdfpages} % for inline inclusion of pdfs
\usepackage{pdflscape} % for making pages landscape (so included pdfs can still get figure names and header/footer)
\RequirePackage{fancyhdr} % because howtos don't require it
% remove blank pages that are a result of a twopage document class
\let\cleardoublepage\clearpage
% howtos are not fancy by default
\pagestyle{normal}
% for box drawing
\usepackage{pmboxdraw}
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 sphinx_rigado_extensions import __version__
setup(
name='sphinx_rigado_extensions',
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=['sphinx_rigado_extensions'],
include_package_data=True,
)
#!/usr/bin/env bash
set -e
cd test-doc
# -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
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = SphinxExample
SOURCEDIR = source
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)
\ No newline at end of file
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>`__.
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=SphinxExample
if "%1" == "" goto help
%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.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd
../../../extensions/sphinx_rigado_extensions/
\ No newline at end of file
../../../theme/sphinx_rigado_theme/
\ No newline at end of file
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