Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
bitmask-vpn
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Vladimir KozLove
bitmask-vpn
Commits
267b606e
Unverified
Commit
267b606e
authored
5 years ago
by
Kali Kaneko
Browse files
Options
Downloads
Patches
Plain Diff
[docs] add documents stub
parent
3a895136
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/Makefile
+19
-0
19 additions, 0 deletions
docs/Makefile
docs/conf.py
+173
-0
173 additions, 0 deletions
docs/conf.py
docs/index.rst
+22
-0
22 additions, 0 deletions
docs/index.rst
with
214 additions
and
0 deletions
docs/Makefile
0 → 100644
+
19
−
0
View file @
267b606e
# 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
This diff is collapsed.
Click to expand it.
docs/conf.py
0 → 100644
+
173
−
0
View file @
267b606e
# -*- 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
=
'
bitmask-vpn
'
copyright
=
'
2019, LEAP Encryption Access Project
'
author
=
'
LEAP Encryption Access Project
'
# The short X.Y version
version
=
''
# The full version, including alpha/beta/rc tags
release
=
'
0.19.7
'
# -- 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
=
'
.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
=
'
bitmask-vpndoc
'
# -- 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
,
'
bitmask-vpn.tex
'
,
'
bitmask-vpn Documentation
'
,
'
LEAP Encryption Access Project
'
,
'
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
,
'
bitmask-vpn
'
,
'
bitmask-vpn 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
,
'
bitmask-vpn
'
,
'
bitmask-vpn Documentation
'
,
author
,
'
bitmask-vpn
'
,
'
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
'
]
This diff is collapsed.
Click to expand it.
docs/index.rst
0 → 100644
+
22
−
0
View file @
267b606e
.. bitmask-vpn documentation master file, created by
sphinx-quickstart on Wed Oct 9 19:52:00 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
bitmask-vpn
=======================================
A White-Label, single-provider VPN Application.
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment