From a77dc8ef9d90a8d99c140222d8788a6a8556e993 Mon Sep 17 00:00:00 2001 From: Christer Edwards Date: Tue, 20 Nov 2018 21:03:08 -0700 Subject: [PATCH] 0.3.20181120 initial RTD build --- .gitignore | 1 + README.md | 8 +- docs/Makefile | 19 +++++ docs/README.md | 1 + docs/conf.py | 179 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst.sample | 20 +++++ 6 files changed, 225 insertions(+), 3 deletions(-) create mode 100644 .gitignore create mode 100644 docs/Makefile create mode 120000 docs/README.md create mode 100644 docs/conf.py create mode 100644 docs/index.rst.sample diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..accb26a4 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +docs/_build diff --git a/README.md b/README.md index d9538c71..7983061d 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ pkg add https://github.com/BastilleBSD/bastille/releases/download/0.3.20181114/b Basic Usage ----------- -``` +```shell ishmael ~ # bastille -h Usage: bastille command [ALL|glob] [args] @@ -68,7 +68,7 @@ the firewall, permitting and denying traffic as needed. First, create the loopback interface: ```shell -ishmael ~ # sysrc cloned_interfaces="lo1" +ishmael ~ # sysrc cloned_interfaces+=lo1 ishmael ~ # service netif cloneup ``` @@ -489,7 +489,9 @@ work as expected. This table outlines those requirements: | PRE/CMD | /bin/sh command | /usr/bin/chsh -s /usr/local/bin/zsh | | CONFIG | path | etc root usr | | PKG | port/pkg name(s) | vim-console zsh git-lite tree htop | -| SYSRC | sysrc command(s) | nginx_enable="YES" nginx_flags="..." | +| SYSRC | sysrc command(s) | nginx_enable=YES | + +Note: SYSRC requires NO quotes or that quotes (`"`) be escaped. ie; `\"`) In addition to supporting template hooks, Bastille supports overlaying files into the jail. This is done by placing the files in their full path, using the diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..298ea9e2 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +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) \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 120000 index 00000000..32d46ee8 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..4a6c792b --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,179 @@ +# -*- 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 = 'Bastille' +copyright = '2018, Christer Edwards' +author = 'Christer Edwards' + +# The short X.Y version +version = '0.3' +# The full version, including alpha/beta/rc tags +release = 'beta' + + +# -- 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 = [ +] + +# 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 = '.md' + +from recommonmark.parser import CommonMarkParser +source_parsers = { + '.md': CommonMarkParser, +} + +# The master toctree document. +master_doc = 'README' + +# 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 = 'Bastilledoc' + + +# -- 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, 'Bastille.tex', 'Bastille Documentation', + 'Christer Edwards', '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, 'bastille', 'Bastille 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, 'Bastille', 'Bastille Documentation', + author, 'Bastille', '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'] + diff --git a/docs/index.rst.sample b/docs/index.rst.sample new file mode 100644 index 00000000..25e15cae --- /dev/null +++ b/docs/index.rst.sample @@ -0,0 +1,20 @@ +.. Bastille documentation master file, created by + sphinx-quickstart on Tue Nov 20 20:48:22 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Bastille's documentation! +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`