Commit fbea9068 authored by Drew's avatar Drew

Documentation

parent d2316aa3
Pipeline #2781 failed with stages
in 1 second
......@@ -16,3 +16,4 @@ DerivedData
*.xcuserstate
Carthage/Build
Carthage/Checkouts
docs/_build
types:
- test
- package
variables:
XCSBOT: "6660d0a3ccbde71d961a5f232308a5bc"
GITLAB_PROJECT_ID: "10"
APP_NAME: "FISA"
xcs:
type: test
test:
stage: test
script:
- "CJ=/Applications/CaveJohnson.app/Contents/MacOS/CaveJohnsonCLI"
- "$CJ forceGitLabBranch --branchName CaveJohnsonAuto --hostname code.sealedabstract.com --projectID $GITLAB_PROJECT_ID"
- "sleep 1"
- "XCSBUILDNO=`/Applications/CaveJohnson.app/Contents/MacOS/CaveJohnsonCLI xcsIntegrateNow --botID $XCSBOT --hostname localhost --sslPolicy localhost`"
- "echo XCS BUILDNO $XCSBUILDNO"
- "$CJ waitForIntegration --hostname localhost --botID $XCSBOT --sslPolicy localhost --buildNumber $XCSBUILDNO"
- "$CJ xcsStatusToShell --hostname localhost --botID $XCSBOT --sslPolicy localhost --buildNumber $XCSBUILDNO"
- "ZIPFILE=$($CJ getNameVersionString --infoPlistPath ${APP_NAME}/Info.plist --productName ${APP_NAME})-dev-${CI_BUILD_ID}.zip"
- "mv /tmp/${APP_NAME}/out.zip /tmp/${APP_NAME}/$ZIPFILE"
- atbuild check --configuration test
tags:
- xcode8symlink
- atbuild
package:
stage: package
script:
- atbuild tool-homebrew --configuration release
tags:
- atbuild
- package-homebrew
artifacts:
paths:
- bin/*.xz
docs:
stage: package
script:
- cd docs
- make html
tags:
- autoscale-linux
artifacts:
paths:
- /tmp/FISA
only:
- master
paths:
- docs/_build/html
image: drewcrawford/anarchy-sphinx:latest
......@@ -140,7 +140,7 @@ private final class GetSecret : CLIKit.EasyCommand {
}
let _ = FISAKit.registerText
let metaCommand = MetaCommand(name: "fisa", subcommands: [IdentityCreationCommand(), CreateFISACommand(), PrintFISACommand(), GetPublicIdentity(), AddPublicIdentity(), RemovePublicIdentity(), SetSecret(), RemoveSecret(), GetSecret()])
let metaCommand = MetaCommand(name: "fisa", version: "2.0", subcommands: [IdentityCreationCommand(), CreateFISACommand(), PrintFISACommand(), GetPublicIdentity(), AddPublicIdentity(), RemovePublicIdentity(), SetSecret(), RemoveSecret(), GetSecret()])
if let parseResult = metaCommand.parseArguments() {
metaCommand.command(parseResult)
}
......@@ -43,7 +43,7 @@ public enum FISA {
var nonAuthoringIdentities: [Identity] = []
public var secrets: [String: String] = [:]
private var authoringIdentity: AuthoringIdentity
private let _registeredLegalText = registerText
private let _registeredLegalText: Void = registerText
var identities: [Identity] {
......
This diff is collapsed.
(package
:name "FISA"
:version "2.0"
:external-packages [
{
:url "https://code.sealedabstract.com/drewcrawford/Caroline.git"
:version [">= 1.1"]
:if-including ["test"]
}
{
:url "https://code.sealedabstract.com/drewcrawford/pianissimo.git"
......@@ -16,7 +18,7 @@
}
{
:url "https://code.sealedabstract.com/drewcrawford/CLIKit.git"
:version [">= 2.0"]
:branch "master"
}
]
......@@ -59,5 +61,19 @@
:use-overlays ["NaOH.link"]
}
:tool-atbin {
:tool "packageatbin"
:name "fisa"
:platforms ["all"]
:atllbuild-task "default"
}
:tool-homebrew {
:tool "package-homebrew.attool"
:name "fisa"
:url "FIXME"
:dependencies ["tool-atbin"]
}
}
)
\ No newline at end of file
FISAKit reference
==================
FISAKit is an embeddedable library you can use inside other applications.
.. autoswift:: FISA
:members:
\ No newline at end of file
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " epub3 to make an epub3"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
@echo " dummy to check syntax errors of document sources"
.PHONY: clean
clean:
rm -rf $(BUILDDIR)/*
.PHONY: html
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
.PHONY: singlehtml
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
.PHONY: pickle
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
.PHONY: json
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
.PHONY: htmlhelp
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
.PHONY: qthelp
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FISA.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FISA.qhc"
.PHONY: applehelp
applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."
.PHONY: devhelp
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/FISA"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FISA"
@echo "# devhelp"
.PHONY: epub
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
.PHONY: epub3
epub3:
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
.PHONY: latex
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
.PHONY: latexpdf
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: latexpdfja
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: text
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
.PHONY: texinfo
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
.PHONY: info
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
.PHONY: gettext
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
.PHONY: changes
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
.PHONY: linkcheck
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
.PHONY: doctest
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: coverage
coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
.PHONY: xml
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
.PHONY: pseudoxml
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
.PHONY: dummy
dummy:
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
@echo
@echo "Build finished. Dummy builder generates no files."
dd {
margin-left: 30px;
}
.navbar-brand img {
width: 24px;
height: 24px;
display: inline;
}
code {
color: #29abe0;
}
code.descclassname {
color: #29abe0;
}
\ No newline at end of file
{# Import the theme's layout. #}
{% extends "!layout.html" %}
{# Custom CSS overrides #}
{% set bootswatch_css_custom = ['_static/my-styles.css'] %}
\ No newline at end of file
This diff is collapsed.
How It Works
=============
.. code-block:: text
FISA: a method for sharing secrets
┏━━━━━━━━━━━━━━┓ ┌──────────┐
┃ ┃ ┌─────│ developer│
┌──────────┐ ┃ FISA ┃ │ └──────────┘
│ developer│─────▶┃ secrets ┃◀─┬──┘
└──────────┘ ┃ ┃ │
┃ ┃ │ ┌─────────────┐
┗━━━━━━━━━━━━━━┛ └──│ build server│
▲ └─────────────┘
┌──────────┐ │
│ developer│───────┘
└──────────┘
A FISA file contains your secrets
.. code-block:: text
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ AWS account: XXXXXXX ┃
┃ Backend token: XXXXXX ┃
┃ Apple certificate: XXXXXX ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
And is encrypted* with a one-time key
.. code-block:: text
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ┃ *crypto_secretbox_xsalsa20poly1305
┃ AWS account: XXXXXXX ┃
┃│ Backend token: XXXXXX │ ┃
┃ Apple certificate: XXXXXX ┃
┃│ │ ┃
┃Encrypted with OTK ─ ─ ─ ─ ─ ─ ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
The one-time key is encrypted** with everybody's public key (crypto_box_curve25519xsalsa20poly1305)
.. code-block:: text
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ╔══════════════════════════════════╗ ┃
┃ AWS account: XXXXXXX ║ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃
┃│ Backend token: XXXXXX │ ║ Alice: YYYYYYYYYYYYYYYYYY │ ║ ┃
┃ Apple certificate: XXXXXX ║ ├ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃
┃│ │ ║ Bob: ZZZZZZZZZZZZZZZZZZ │ ║ ┃
┃Encrypted with OTK ─ ─ ─ ─ ─ ─ ║ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃
┃ ║ ║ ┃
┃ OTK lookup table═══════════════════╝ ┃
Actual FISA format━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
So only the named users have access to the secrets
.. code-block:: text
┌─────────┐
┏━━━━│ Alice │
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╋┓ └─────────┘
┃┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ╔══════════════════════════════════╗ ┃┃
┃ AWS account: XXXXXXX ║ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃┃
┃│ Backend token: XXXXXX │ ┏╬━━━━━━━━ YYYYYYYYYYYYYYYYYY │◀━╬━┛┃
┃ Apple certificate: XXXXXX◀━━━━━━━┛║ ├ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃
┃│ │ ║ Bob: ZZZZZZZZZZZZZZZZZZ │ ║ ┃
┃Encrypted with OTK ─ ─ ─ ─ ─ ─ ║ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃
┃ ║ ║ ┃
┃ OTK lookup table═══════════════════╝ ┃
Actual FISA format━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
To remove a user, simply drop them from the file
.. code-block:: bash
$ FISAcli removeIdentity --identityDescription Alice
.. code-block:: text
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ╔══════════════════════════════════╗ ┃ ┌─────────┐
┃ AWS account: XXXXXXX ║ !!◀━━━━╬━━╋━━━━━━━━│ Alice │
┃│ Backend token: XXXXXX │ ║ ║ ┃ └─────────┘
┃ Apple certificate: XXXXXX ║ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃
┃│ │ ║ Bob: ZZZZZZZZZZZZZZZZZZ │ ║ ┃
┃Encrypted with OTK ─ ─ ─ ─ ─ ─ ║ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ║ ┃
┃ ║ ║ ┃
┃ OTK lookup table═══════════════════╝ ┃
Actual FISA format━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
FISA is perfect for community projects, open source repositories, or any time that you need to check secrets into source control.
One unique feature of FISA is that it can be used programmatically, via FISAKit. So you can access your secrets inside unit tests.
.. code-block:: text
┌──────────────────┐────────────I need S3 secret──────────▶┏━━━━━━━━━━━━━━━━━┓
│ S3 Upload Test │ ┃ ┃ ╔════════════════╗
│ │ ┃ ┃ ║Actual usecase! ║
│ │ ┃ FISA ┃ ╚════════════════╝▒▒
│ │◀──────────────Here you go─────────────┃ ┃ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
│ │ ┃ ┃ ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
│ │ ┃ ┃
Application────────┘ ┗━━━━━━━━━━━━━━━━━┛
\ No newline at end of file
.. FISA documentation master file, created by
sphinx-quickstart on Sun Oct 23 21:20:44 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to FISA's documentation!
================================
Contents:
.. toctree::
:maxdepth: 2
howitworks
KitReference
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
set I18NSPHINXOPTS=%SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. epub3 to make an epub3
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
echo. coverage to run coverage check of the documentation if enabled
echo. dummy to check syntax errors of document sources
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
REM Check if sphinx-build is available and fallback to Python version if any
%SPHINXBUILD% 1>NUL 2>NUL
if errorlevel 9009 goto sphinx_python
goto sphinx_ok
:sphinx_python
set SPHINXBUILD=python -m sphinx.__init__
%SPHINXBUILD% 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
)
:sphinx_ok
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\FISA.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\FISA.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "epub3" (
%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %~dp0
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %~dp0
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)