Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
jdurrant
binana
Commits
e1b23df6
Commit
e1b23df6
authored
Aug 09, 2021
by
jdurrant
Browse files
Removed docs directory (not part of repo)
parent
cf25eaae
Changes
8
Hide whitespace changes
Inline
Side-by-side
.gitignore
View file @
e1b23df6
...
...
@@ -21,3 +21,4 @@ _build
docs/docs
.ipynb_checkpoints
make.bat
docs
docs/compile/Makefile
deleted
100644 → 0
View file @
cf25eaae
# 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
docs/compile/README.md
deleted
100644 → 0
View file @
cf25eaae
# Compile Documentation
This directory contains the files needed to generate BINANA documentation using
`sphinx`
. To compile the documentation, run
`./compile.sh`
. The output is
written to
`../dist/`
.
Works only on UNIX-like systems.
\ No newline at end of file
docs/compile/_static/EMPTY.md
deleted
100644 → 0
View file @
cf25eaae
docs/compile/_templates/EMPTY.md
deleted
100644 → 0
View file @
cf25eaae
docs/compile/compile.sh
deleted
100755 → 0
View file @
cf25eaae
# Must use Python3
source
activate Python36
# Clean up previous builds
rm
-rf
_rst
# First, convert python source code to rst
mkdir
_rst
sphinx-apidoc
--module-first
-f
-o
_rst/ ../../binana/
# Copy README.md here.
cp
../../README.md ./tmp.md
make html
rm
-rf
../docs
mv
_build/html ../docs
# Tweak the styles a bit
echo
>>
../docs/_static/bizstyle.css
echo
".field-name {min-width:90px;}"
>>
../docs/_static/bizstyle.css
echo
".field-body {padding-left:10px !important;}"
>>
../docs/_static/bizstyle.css
# Delete README.md file
rm
tmp.md
docs/compile/conf.py
deleted
100644 → 0
View file @
cf25eaae
# -*- 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
=
u
'BINANA'
copyright
=
u
'2021, Jacob D. Durrant'
author
=
u
'Jacob D. Durrant'
# The short X.Y version
version
=
u
''
# The full version, including alpha/beta/rc tags
release
=
u
''
# -- 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.doctest'
,
'sphinx.ext.coverage'
,
'sphinx.ext.viewcode'
,
'sphinx.ext.napoleon'
,
'myst_parser'
]
napoleon_numpy_docstring
=
False
# 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
=
[
u
'_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
=
'bizstyle'
# 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
=
'BINANAdoc'
# -- 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
,
'BINANA.tex'
,
u
'BINANA Documentation'
,
u
'Jacob D. Durrant'
,
'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
,
'binana'
,
u
'BINANA 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
,
'BINANA'
,
u
'BINANA Documentation'
,
author
,
'BINANA'
,
'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 -------------------------------------------------
docs/compile/index.rst
deleted
100644 → 0
View file @
cf25eaae
.. BINANA documentation master file, created by
sphinx-quickstart on Thu Jul 22 02:20:10 2021. You can adapt this file
completely to your liking, but it should at least contain the root `toctree`
directive. You can add :caption: Technical Notes: to the toctree:
Welcome to BINANA's documentation!
==================================
Technical notes
===============
.. toctree::
:maxdepth: 2
tmp.md
Code documentation
==================
.. toctree::
:maxdepth: 1
_rst/modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment