Minimize build config
This commit is contained in:
parent
159b7faff2
commit
0c078af67e
|
@ -0,0 +1,39 @@
|
|||
name: build
|
||||
|
||||
on:
|
||||
push:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.9.0-beta.4 - 3.9.0
|
||||
|
||||
- name: Install Dependencies
|
||||
run: python -m pip install Sphinx
|
||||
|
||||
- name: Build Site
|
||||
run: make html
|
||||
|
||||
- name: Setup Authentication
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: >
|
||||
git remote set-url origin
|
||||
"https://token:$GITHUB_TOKEN@github.com/$GITHUB_REPOSITORY"
|
||||
|
||||
- name: Deploy
|
||||
run: |
|
||||
git config user.email "mcsinyx@disroot.org"
|
||||
git config user.name "Raphael McSinyx"
|
||||
git init
|
||||
git checkout -b gh-pages
|
||||
git add .
|
||||
git commit -m "Build $(date -I)"
|
||||
git push origin gh-pages --force
|
|
@ -1,28 +0,0 @@
|
|||
name: docs_pages_workflow
|
||||
|
||||
# execute this workflow automatically when a we push to master
|
||||
on:
|
||||
push:
|
||||
|
||||
jobs:
|
||||
|
||||
build_docs_job:
|
||||
runs-on: ubuntu-latest
|
||||
container: debian:buster-slim
|
||||
|
||||
steps:
|
||||
|
||||
- name: Prereqs
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
apt-get update
|
||||
apt-get install -y git
|
||||
git clone "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" .
|
||||
shell: bash
|
||||
|
||||
- name: Execute script to build our documentation and update pages
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: "docs/buildDocs.sh"
|
||||
shell: bash
|
|
@ -1,2 +1,129 @@
|
|||
__pycache__
|
||||
*.pyc
|
||||
# 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/
|
||||
pip-wheel-metadata/
|
||||
share/python-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/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
db.sqlite3
|
||||
db.sqlite3-journal
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# IPython
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# pipenv
|
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
||||
# install all needed dependencies.
|
||||
#Pipfile.lock
|
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
||||
__pypackages__/
|
||||
|
||||
# Celery stuff
|
||||
celerybeat-schedule
|
||||
celerybeat.pid
|
||||
|
||||
# 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/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
|
|
|
@ -1,11 +1,12 @@
|
|||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?=
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = .
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
|
@ -16,4 +17,4 @@ help:
|
|||
# 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)
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
@ -1,3 +0,0 @@
|
|||
*.swp
|
||||
/_build
|
||||
/doctrees
|
Binary file not shown.
Before Width: | Height: | Size: 141 KiB |
Binary file not shown.
Before Width: | Height: | Size: 624 KiB |
|
@ -1,55 +0,0 @@
|
|||
{% if READTHEDOCS or display_lower_left %}
|
||||
{# Add rst-badge after rst-versions for small badge style. #}
|
||||
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
|
||||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||||
<span class="fa fa-book"> Read the Docs</span>
|
||||
v: {{ current_version }}
|
||||
<span class="fa fa-caret-down"></span>
|
||||
</span>
|
||||
<div class="rst-other-versions">
|
||||
{% if languages|length >= 1 %}
|
||||
<dl>
|
||||
<dt>{{ _('Languages') }}</dt>
|
||||
{% for slug, url in languages %}
|
||||
{% if slug == current_language %} <strong> {% endif %}
|
||||
<dd><a href="{{ url }}">{{ slug }}</a></dd>
|
||||
{% if slug == current_language %} </strong> {% endif %}
|
||||
{% endfor %}
|
||||
</dl>
|
||||
{% endif %}
|
||||
{% if versions|length >= 1 %}
|
||||
<dl>
|
||||
<dt>{{ _('Versions') }}</dt>
|
||||
{% for slug, url in versions %}
|
||||
{% if slug == current_version %} <strong> {% endif %}
|
||||
<dd><a href="{{ url }}">{{ slug }}</a></dd>
|
||||
{% if slug == current_version %} </strong> {% endif %}
|
||||
{% endfor %}
|
||||
</dl>
|
||||
{% endif %}
|
||||
{% if downloads|length >= 1 %}
|
||||
<dl>
|
||||
<dt>{{ _('Downloads') }}</dt>
|
||||
{% for type, url in downloads %}
|
||||
<dd><a href="{{ url }}">{{ type }}</a></dd>
|
||||
{% endfor %}
|
||||
</dl>
|
||||
{% endif %}
|
||||
{% if READTHEDOCS %}
|
||||
<dl>
|
||||
<dt>{{ _('On Read the Docs') }}</dt>
|
||||
<dd>
|
||||
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
|
||||
</dd>
|
||||
<dd>
|
||||
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
|
||||
</dd>
|
||||
</dl>
|
||||
{% endif %}
|
||||
<hr/>
|
||||
{% trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.{% endtrans %}
|
||||
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
.. _autodoc:
|
||||
|
||||
helloWorld.py
|
||||
=============
|
||||
|
||||
.. automodule:: helloWorld
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
@ -1,153 +0,0 @@
|
|||
#!/bin/bash
|
||||
set -x
|
||||
################################################################################
|
||||
# File: buildDocs.sh
|
||||
# Purpose: Script that builds our documentation using sphinx and updates GitHub
|
||||
# Pages. This script is executed by:
|
||||
# .github/workflows/docs_pages_workflow.yml
|
||||
#
|
||||
# Authors: Michael Altfield <michael@michaelaltfield.net>
|
||||
# Created: 2020-07-17
|
||||
# Updated: 2020-07-20
|
||||
# Version: 0.2
|
||||
################################################################################
|
||||
|
||||
###################
|
||||
# INSTALL DEPENDS #
|
||||
###################
|
||||
|
||||
apt-get update
|
||||
apt-get -y install git rsync python3-sphinx python3-sphinx-rtd-theme python3-stemmer python3-git python3-pip python3-virtualenv python3-setuptools
|
||||
|
||||
python3 -m pip install --upgrade rinohtype pygments
|
||||
|
||||
#####################
|
||||
# DECLARE VARIABLES #
|
||||
#####################
|
||||
|
||||
pwd
|
||||
ls -lah
|
||||
export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct)
|
||||
|
||||
# make a new temp dir which will be our GitHub Pages docroot
|
||||
docroot=`mktemp -d`
|
||||
|
||||
export REPO_NAME="${GITHUB_REPOSITORY##*/}"
|
||||
|
||||
##############
|
||||
# BUILD DOCS #
|
||||
##############
|
||||
|
||||
# first, cleanup any old builds' static assets
|
||||
make -C docs clean
|
||||
|
||||
# get a list of branches, excluding 'HEAD' and 'gh-pages'
|
||||
versions="`git for-each-ref '--format=%(refname:lstrip=-1)' refs/remotes/origin/ | grep -viE '^(HEAD|gh-pages)$'`"
|
||||
for current_version in ${versions}; do
|
||||
|
||||
# make the current language available to conf.py
|
||||
export current_version
|
||||
git checkout ${current_version}
|
||||
|
||||
echo "INFO: Building sites for ${current_version}"
|
||||
|
||||
# skip this branch if it doesn't have our docs dir & sphinx config
|
||||
if [ ! -e 'docs/conf.py' ]; then
|
||||
echo -e "\tINFO: Couldn't find 'docs/conf.py' (skipped)"
|
||||
continue
|
||||
fi
|
||||
|
||||
languages="en `find docs/locales/ -mindepth 1 -maxdepth 1 -type d -exec basename '{}' \;`"
|
||||
for current_language in ${languages}; do
|
||||
|
||||
# make the current language available to conf.py
|
||||
export current_language
|
||||
|
||||
##########
|
||||
# BUILDS #
|
||||
##########
|
||||
echo "INFO: Building for ${current_language}"
|
||||
|
||||
# HTML #
|
||||
sphinx-build -b html docs/ docs/_build/html/${current_language}/${current_version} -D language="${current_language}"
|
||||
|
||||
# PDF #
|
||||
sphinx-build -b rinoh docs/ docs/_build/rinoh -D language="${current_language}"
|
||||
mkdir -p "${docroot}/${current_language}/${current_version}"
|
||||
cp "docs/_build/rinoh/target.pdf" "${docroot}/${current_language}/${current_version}/helloWorld-docs_${current_language}_${current_version}.pdf"
|
||||
|
||||
# EPUB #
|
||||
sphinx-build -b epub docs/ docs/_build/epub -D language="${current_language}"
|
||||
mkdir -p "${docroot}/${current_language}/${current_version}"
|
||||
cp "docs/_build/epub/target.epub" "${docroot}/${current_language}/${current_version}/helloWorld-docs_${current_language}_${current_version}.epub"
|
||||
|
||||
# copy the static assets produced by the above build into our docroot
|
||||
rsync -av "docs/_build/html/" "${docroot}/"
|
||||
|
||||
done
|
||||
|
||||
done
|
||||
|
||||
# return to master branch
|
||||
git checkout master
|
||||
|
||||
#######################
|
||||
# Update GitHub Pages #
|
||||
#######################
|
||||
|
||||
git config --global user.name "${GITHUB_ACTOR}"
|
||||
git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
|
||||
|
||||
pushd "${docroot}"
|
||||
|
||||
# don't bother maintaining history; just generate fresh
|
||||
git init
|
||||
git remote add deploy "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
|
||||
git checkout -b gh-pages
|
||||
|
||||
# add .nojekyll to the root so that github won't 404 on content added to dirs
|
||||
# that start with an underscore (_), such as our "_content" dir..
|
||||
touch .nojekyll
|
||||
|
||||
# add redirect from the docroot to our default docs language/version
|
||||
cat > index.html <<EOF
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title>helloWorld Docs</title>
|
||||
<meta http-equiv = "refresh" content="0; url='/${REPO_NAME}/en/master/'" />
|
||||
</head>
|
||||
<body>
|
||||
<p>Please wait while you're redirected to our <a href="/${REPO_NAME}/en/master/">documentation</a>.</p>
|
||||
</body>
|
||||
</html>
|
||||
EOF
|
||||
|
||||
# Add README
|
||||
cat > README.md <<EOF
|
||||
# GitHub Pages Cache
|
||||
|
||||
Nothing to see here. The contents of this branch are essentially a cache that's not intended to be viewed on github.com.
|
||||
|
||||
|
||||
If you're looking to update our documentation, check the relevant development branch's 'docs/' dir.
|
||||
|
||||
For more information on how this documentation is built using Sphinx, Read the Docs, and GitHub Actions/Pages, see:
|
||||
|
||||
* https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1
|
||||
EOF
|
||||
|
||||
# copy the resulting html pages built from sphinx above to our new git repo
|
||||
git add .
|
||||
|
||||
# commit all the new files
|
||||
msg="Updating Docs for commit ${GITHUB_SHA} made on `date -d"@${SOURCE_DATE_EPOCH}" --iso-8601=seconds` from ${GITHUB_REF} by ${GITHUB_ACTOR}"
|
||||
git commit -am "${msg}"
|
||||
|
||||
# overwrite the contents of the gh-pages branch on our github.com repo
|
||||
git push deploy gh-pages --force
|
||||
|
||||
popd # return to main repo sandbox root
|
||||
|
||||
# exit cleanly
|
||||
exit 0
|
271
docs/conf.py
271
docs/conf.py
|
@ -1,271 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file does only contain a selection of the most common options. For a
|
||||
# full list see the documentation:
|
||||
# http://www.sphinx-doc.org/en/master/config
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'helloWorld'
|
||||
copyright = '2020, Michael Altfield'
|
||||
author = 'Michael Altfield'
|
||||
|
||||
# The short X.Y version
|
||||
version = ''
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '1.0.0'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx_rtd_theme',
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.githubpages',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = None
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
#html_theme = 'alabaster'
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
#
|
||||
# The default sidebars (for documents that don't match any pattern) are
|
||||
# defined by theme itself. Builtin themes are using these templates by
|
||||
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
||||
# 'searchbox.html']``.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'helloWorlddoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'helloWorld.tex', 'helloWorld Documentation',
|
||||
'Michael Altfield', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'helloworld', 'helloWorld Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Texinfo output ----------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'helloWorld', 'helloWorld Documentation',
|
||||
author, 'helloWorld', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Epub output -------------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = project
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#
|
||||
# epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#
|
||||
# epub_uid = ''
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
epub_exclude_files = ['search.html']
|
||||
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
||||
|
||||
# add sourcecode to path
|
||||
import sys, os
|
||||
sys.path.insert(0, os.path.abspath('../src'))
|
||||
|
||||
############################
|
||||
# SETUP THE RTD LOWER-LEFT #
|
||||
############################
|
||||
try:
|
||||
html_context
|
||||
except NameError:
|
||||
html_context = dict()
|
||||
html_context['display_lower_left'] = True
|
||||
|
||||
if 'REPO_NAME' in os.environ:
|
||||
REPO_NAME = os.environ['REPO_NAME']
|
||||
else:
|
||||
REPO_NAME = ''
|
||||
|
||||
# SET CURRENT_LANGUAGE
|
||||
if 'current_language' in os.environ:
|
||||
# get the current_language env var set by buildDocs.sh
|
||||
current_language = os.environ['current_language']
|
||||
else:
|
||||
# the user is probably doing `make html`
|
||||
# set this build's current language to english
|
||||
current_language = 'en'
|
||||
|
||||
# tell the theme which language to we're currently building
|
||||
html_context['current_language'] = current_language
|
||||
|
||||
# SET CURRENT_VERSION
|
||||
from git import Repo
|
||||
repo = Repo( search_parent_directories=True )
|
||||
|
||||
if 'current_version' in os.environ:
|
||||
# get the current_version env var set by buildDocs.sh
|
||||
current_version = os.environ['current_version']
|
||||
else:
|
||||
# the user is probably doing `make html`
|
||||
# set this build's current version by looking at the branch
|
||||
current_version = repo.active_branch.name
|
||||
|
||||
# tell the theme which version we're currently on ('current_version' affects
|
||||
# the lower-left rtd menu and 'version' affects the logo-area version)
|
||||
html_context['current_version'] = current_version
|
||||
html_context['version'] = current_version
|
||||
|
||||
# POPULATE LINKS TO OTHER LANGUAGES
|
||||
html_context['languages'] = [ ('en', '/' +REPO_NAME+ '/en/' +current_version+ '/') ]
|
||||
|
||||
languages = [lang.name for lang in os.scandir('locales') if lang.is_dir()]
|
||||
for lang in languages:
|
||||
html_context['languages'].append( (lang, '/' +REPO_NAME+ '/' +lang+ '/' +current_version+ '/') )
|
||||
|
||||
# POPULATE LINKS TO OTHER VERSIONS
|
||||
html_context['versions'] = list()
|
||||
|
||||
versions = [branch.name for branch in repo.branches]
|
||||
for version in versions:
|
||||
html_context['versions'].append( (version, '/' +REPO_NAME+ '/' +current_language+ '/' +version+ '/') )
|
||||
|
||||
# POPULATE LINKS TO OTHER FORMATS/DOWNLOADS
|
||||
|
||||
# settings for creating PDF with rinoh
|
||||
rinoh_documents = [(
|
||||
master_doc,
|
||||
'target',
|
||||
project+ ' Documentation',
|
||||
'© ' +copyright,
|
||||
)]
|
||||
today_fmt = "%B %d, %Y"
|
||||
|
||||
# settings for EPUB
|
||||
epub_basename = 'target'
|
||||
|
||||
html_context['downloads'] = list()
|
||||
html_context['downloads'].append( ('pdf', '/' +REPO_NAME+ '/' +current_language+ '/' +current_version+ '/' +project+ '-docs_' +current_language+ '_' +current_version+ '.pdf') )
|
||||
|
||||
html_context['downloads'].append( ('epub', '/' +REPO_NAME+ '/' +current_language+ '/' +current_version+ '/' +project+ '-docs_' +current_language+ '_' +current_version+ '.epub') )
|
||||
|
||||
##########################
|
||||
# "EDIT ON GITHUB" LINKS #
|
||||
##########################
|
||||
|
||||
html_context['display_github'] = True
|
||||
html_context['github_user'] = 'maltfield'
|
||||
html_context['github_repo'] = 'rtd-github-pages'
|
||||
html_context['github_version'] = 'master/docs/'
|
||||
|
|
@ -1,179 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file does only contain a selection of the most common options. For a
|
||||
# full list see the documentation:
|
||||
# http://www.sphinx-doc.org/en/master/config
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'helloWorld'
|
||||
copyright = '2020, Michael Altfield'
|
||||
author = 'Michael Altfield'
|
||||
|
||||
# The short X.Y version
|
||||
version = ''
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '1.0.0'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.githubpages',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = None
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
# html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
#
|
||||
# The default sidebars (for documents that don't match any pattern) are
|
||||
# defined by theme itself. Builtin themes are using these templates by
|
||||
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
||||
# 'searchbox.html']``.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'helloWorlddoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'helloWorld.tex', 'helloWorld Documentation',
|
||||
'Michael Altfield', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'helloworld', 'helloWorld Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Texinfo output ----------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'helloWorld', 'helloWorld Documentation',
|
||||
author, 'helloWorld', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Epub output -------------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = project
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#
|
||||
# epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#
|
||||
# epub_uid = ''
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
epub_exclude_files = ['search.html']
|
||||
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
Binary file not shown.
|
@ -1,43 +0,0 @@
|
|||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2020, Michael Altfield
|
||||
# This file is distributed under the same license as the helloWorld package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: helloWorld \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2020-07-20 14:57+0545\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=utf-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.6.0\n"
|
||||
|
||||
#: ../../autodoc.rst:3
|
||||
msgid "Contents"
|
||||
msgstr ""
|
||||
|
||||
#: ../../autodoc.rst:6
|
||||
msgid "helloWorld.py"
|
||||
msgstr ""
|
||||
|
||||
#: helloWorld:1 of
|
||||
msgid "This is a very simple helloWorld python script"
|
||||
msgstr ""
|
||||
|
||||
#: helloWorld.helloWorld:1 of
|
||||
msgid "This is a simple function that prints a message"
|
||||
msgstr ""
|
||||
|
||||
#: helloWorld.helloWorld:3 of
|
||||
msgid "Parameters:"
|
||||
msgstr ""
|
||||
|
||||
#: helloWorld.helloWorld:4 of
|
||||
msgid "msg (str): The string to print"
|
||||
msgstr ""
|
||||
|
Binary file not shown.
|
@ -1,43 +0,0 @@
|
|||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2020, Michael Altfield
|
||||
# This file is distributed under the same license as the helloWorld package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, 2020.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: helloWorld \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2020-07-20 14:57+0545\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=utf-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
"Generated-By: Babel 2.6.0\n"
|
||||
|
||||
#: ../../index.rst:7
|
||||
msgid "Welcome to helloWorld's documentation!"
|
||||
msgstr "¡Bienvenido a la documentación de helloWorld!"
|
||||
|
||||
#: ../../index.rst:9
|
||||
msgid "Contents:"
|
||||
msgstr "Contenidos:"
|
||||
|
||||
#: ../../index.rst:17
|
||||
msgid "Indices and tables"
|
||||
msgstr ""
|
||||
|
||||
#: ../../index.rst:19
|
||||
msgid ":ref:`genindex`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../index.rst:20
|
||||
msgid ":ref:`modindex`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../index.rst:21
|
||||
msgid ":ref:`search`"
|
||||
msgstr ""
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
@ECHO OFF
|
||||
|
||||
pushd %~dp0
|
||||
|
||||
REM Command file for Sphinx documentation
|
||||
|
||||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
|
||||
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
|
|
@ -0,0 +1,2 @@
|
|||
<!-- Redirect to build/html -->
|
||||
<meta HTTP-EQUIV="REFRESH" content="0; url=html/">
|
|
@ -0,0 +1,52 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Raphael McSinyx'
|
||||
copyright = '2020, Nguyễn Gia Phong'
|
||||
author = 'Nguyễn Gia Phong'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'alabaster'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
|
@ -1,16 +1,15 @@
|
|||
.. helloWorld documentation master file, created by
|
||||
sphinx-quickstart on Fri Jul 17 10:38:59 2020.
|
||||
.. Raphael McSinyx documentation master file, created by
|
||||
sphinx-quickstart on Fri Aug 7 14:57:51 2020.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to helloWorld's documentation!
|
||||
======================================
|
||||
Welcome to Raphael McSinyx's documentation!
|
||||
===========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
autodoc
|
||||
|
||||
|
||||
Indices and tables
|
|
@ -1,13 +0,0 @@
|
|||
"""This is a very simple helloWorld python script"""
|
||||
def helloWorld( msg ):
|
||||
"""
|
||||
This is a simple function that prints a message
|
||||
|
||||
Parameters:
|
||||
msg (str): The string to print
|
||||
"""
|
||||
|
||||
print( msg )
|
||||
|
||||
helloWorld( 'Hello World' )
|
||||
|
Loading…
Reference in New Issue