diff --git a/.generate-reports.py b/.generate-reports.py deleted file mode 100755 index ead7b28..0000000 --- a/.generate-reports.py +++ /dev/null @@ -1,254 +0,0 @@ -#!/usr/bin/env python -# -*- coding: UTF-8 -*- -# fancy comments come at a cost! - -# Script to generate a Maven site and push reports to a branch (gh-pages by default). -# This script assumes that both git and Maven have been installed and that the following environment variables -# are defined: -# - REPORTS_GITHUB_ACCESS_TOKEN: GitHub personal access token used to push generated reports -# - REPORTS_GITHUB_USERNAME: username used to push generated reports -# -# Yes, these could be passed as arguments, but Travis log would print them out. - -# Output of this script is to populate the gh-pages branch with the reports generated by running "mvn site". -# The structure of the generated reports is similar to: -# -# (branch gh-pages) # pages_branch option -# reports # base_output_dir option -# ├── development # output_dir positional argument -# │  ├── index.html -# │  ├── pmd.html -# │ ├── jacoco.html -# │ └── ... -# │   -# ├── 1.0.0 # output_dir positional argument -# │  ├── index.html -# │  ├── pmd.html -# │ ├── jacoco.html -# │ └── ... -# │   -# ├── 1.0.1 # output_dir positional argument -# │  ├── index.html -# │  ├── pmd.html -# │ ├── jacoco.html -# │ └── ... -# │   -# └── 2.0.0 # output_dir positional argument -#   ├── index.html -#   ├── pmd.html -# ├── jacoco.html -# └── ... -# -# So only one "development" version of the reports is maintained, while reports for all -# tagged commits--assumed to be releases--are maintained on the gh-pages branch. -# -# The content of each of the folders is whatever Maven generates on the target/site folder. - - -import argparse, os, shutil, subprocess, tempfile, sys, re - -# folder where maven outputs reports generated by running "mvn site" -MAVEN_SITE_DIR = os.path.join('target', 'site') -# base directory where reports will be copied to -BASE_REPORT_DIR = 'reports' -# credentials are given via environment variables -TOKEN_ENV_VARIABLE_NAME = 'REPORTS_GITHUB_ACCESS_TOKEN' -# compiled regex to match files that should not be deleted when cleaning the working folder (in gh-pages) -UNTOUCHABLE_FILES_MATCHER = re.compile('^\.git.*') -# regex to validate output folder -REPORTS_VERSION_REGEX = '^(development|[vV]?\d+\.\d+\.\d+)$' - - -# parses arguments and does the thing -def main(): - parser = argparse.ArgumentParser(description='QBiC Javadoc Generator.', prog='generate-javadocs.py', formatter_class=argparse.ArgumentDefaultsHelpFormatter) - parser.add_argument('-s', '--site-dir', default=MAVEN_SITE_DIR, - help='Directory where Maven reports are found (output of running \'mvn site\').') - parser.add_argument('-b', '--base-output-dir', default=BASE_REPORT_DIR, - help='Base directory where the reports will be copied.') - parser.add_argument('-p', '--pages-branch', default="gh-pages", - help='Name of the git branch on which the reports will be pushed.') - parser.add_argument('-a', '--access-token-var-name', default=TOKEN_ENV_VARIABLE_NAME, - help='Name of the environment variable holding the GitHub personal access token used to push changes in reports.') - parser.add_argument('-r', '--validation-regex', default=REPORTS_VERSION_REGEX, - help='Regular expression to validate output_dir; it is assumed that report folders are named after a version.') - parser.add_argument('--dry-run', action='store_true', - help='If present, no changes to the remote repository (git commit/push) will be executed.') - parser.add_argument('--skip-cleanup', action='store_true', - help='Whether cleanup tasks (removing cloned repos) should be skipped.') - parser.add_argument('output_dir', - help='Name of the folder, relative to the base output directory, where reports will be copied to. \ - This folder will be first cleared of its contents before the generated reports are copied. \ - Recommended values are: "development" or a valid release version string (e.g., 1.0.1)') - parser.add_argument('repo_slug', help='Slug of the repository for which reports are being built.') - parser.add_argument('commit_message', nargs='+', help='Message(s) to use when committing changes.') - args = parser.parse_args() - - # check that the required environment variables have been defined - try: - validateArguments(args) - except Exception as e: - print('Error: {}'.format(str(e)), file=sys.stderr) - exit(1) - - # since this will run on Travis, we cannot assume that we can change the current local repo without breaking anything - # the safest way would be to clone this same repository on a temporary folder and leave the current local repo alone - working_dir = tempfile.mkdtemp() - clone_self(working_dir, args) - - # reports are available only in a specific branch - force_checkout_pages_branch(working_dir, args) - - # since new branches have a parent commit, we have to remove everything but: - # * important files (e.g., .git) - # * the base output directory (args.base_output_dir) - # otherwise, the newly created gh-pages branch will contain other non-report files! - # also, it is a good idea to remove everything, since we don't want lingering unused report files - remove_unneeded_files(working_dir, args) - - # move rports to their place - prepare_report_dir(working_dir, args) - - # add, commit, push - push_to_pages_branch(working_dir, args) - - # clean up - if args.skip_cleanup: - print('Skipping cleanup of working folder {}'.format(working_dir)) - else: - print('Removing working folder {}'.format(working_dir)) - shutil.rmtree(working_dir) - - -# Sanity check -def validateArguments(args): - # check that the required environment variables are present - if not args.access_token_var_name in os.environ: - raise Exception('At least one of the required environment variables is missing. See comments on .generate-reports.py for further information.') - - # check if the name of the output_dir matches the regex - regex = re.compile(args.validation_regex) - if not regex.match(args.output_dir): - raise Exception('The provided output directory for the reports, {}, is not valid. It must match the regex {}'.format(args.output_dir, args.validation_regex)) - - # check that the reports are where they should be (you never know!) - if not os.path.exists(args.site_dir) or not os.path.isdir(args.site_dir): - raise Exception('Maven site folder {} does not exist or is not a directory.'.format(args.site_dir)) - - -# Clones this repo into the passed working directory, credentials are used because OAuth has a bigger quota -# plus, we will be pushing changes to gh-pages branch -def clone_self(working_dir, args, exit_if_fail=True): - execute(['git', 'clone', 'https://{}:x-oauth-basic@github.com/{}'.format(os.environ[args.access_token_var_name], args.repo_slug), working_dir], - 'Could not clone {} in directory {}'.format(args.repo_slug, working_dir), exit_if_fail) - - -# Checks out the branch where reports reside (gh-pages) -def force_checkout_pages_branch(working_dir, args): - # we need to add the gh-pages branch if it doesn't exist (git checkout -b gh-pages), - # but if gh-pages already exists, we need to checkout (git checkout gh-pages), luckily, - # "git checkout branch" fails if branch doesn't exist - print('Changing to branch {}'.format(args.pages_branch)) - try: - execute(['git', '-C', working_dir, 'checkout', args.pages_branch], exit_if_fail=False) - except: - execute(['git', '-C', working_dir, 'checkout', '-b', args.pages_branch], 'Could not create branch {}'.format(args.pages_branch)) - - -# Goes through the all files/folders (non-recursively) and deletes them using 'git rm'. -# Files that should not be deleted are ignored -def remove_unneeded_files(working_dir, args): - print('Cleaning local repository ({}) of non-reports files'.format(working_dir)) - for f in os.listdir(working_dir): - if should_delete(f, args): - # instead of using OS calls to delete files/folders, use git rm to stage deletions - print(' Deleting {} from {} branch'.format(f, args.pages_branch)) - execute(['git', '-C', working_dir, 'rm', '-r', '--ignore-unmatch', f], 'Could not remove {}.'.format(f)) - # files that are not part of the repository aren't removed by git and the --ignore-unmatch flag makes - # git be nice so it doesn't exit with errors, so we need to force-remove them - force_delete(os.path.join(working_dir, f)) - else: - print(' Ignoring file/folder {}'.format(f)) - - -# Prepares the report output directory, first by clearing it and then by moving the contents of target/site into it -def prepare_report_dir(working_dir, args): - report_output_dir = os.path.join(working_dir, args.base_output_dir, args.output_dir) - if os.path.exists(report_output_dir): - if not os.path.isdir(report_output_dir): - print('WARNING: Output destination {} exists and is not a directory.'.format(report_output_dir), file=sys.stderr) - # remove the object from git - print('Removing {}'.format(report_output_dir)) - execute(['git', '-C', working_dir, 'rm', '-r', '--ignore-unmatch', os.path.join(args.base_output_dir, args.output_dir)], - 'Could not remove {}.'.format(report_output_dir)) - # just in case git doesn't remove the file (if it wasn't tracked, for instance), force deletion using OS calls - force_delete(report_output_dir) - # we know the output folder doesn't exist, so we can recreate it - print('Creating {}'.format(report_output_dir)) - os.makedirs(report_output_dir) - - # accidentally the whole target/site folder (well, yes, but actually, no, because we need only its contents) - print('Moving contents of {} to {}'.format(args.site_dir, report_output_dir)) - for f in os.listdir(args.site_dir): - print(' Moving {}'.format(f)) - shutil.move(os.path.join(args.site_dir, f), report_output_dir) - - -# Adds, commits and pushes changes -def push_to_pages_branch(working_dir, args): - if args.dry_run: - print('(running in dry run mode) Local/remote repository will not be modified') - else: - # add changes to the index - print('Staging changes for commit') - execute(['git', '-C', working_dir, 'add', '.'], 'Could not stage reports for commit.') - - # build the git-commit command and commit changes - print('Pushing changes upstream') - git_commit_command = ['git', '-C', working_dir, 'commit'] - for commit_message in args.commit_message: - git_commit_command.extend(['-m', commit_message]) - execute(git_commit_command, 'Could not commit changes') - - # https://www.youtube.com/watch?v=vCadcBR95oU - execute(['git', '-C', working_dir, 'push', '-u', 'origin', args.pages_branch], 'Could not push changes using provided credentials.') - - -# Whether it is safe to delete the given path, we won't delete important files/folders (such as .git) -# or the base output directory -def should_delete(path, args): - return not UNTOUCHABLE_FILES_MATCHER.match(path) and path != args.base_output_dir - - -# Forcefully deletes recursively the passed file/folder using OS calls -def force_delete(file): - if os.path.exists(file): - if os.path.isdir(file): - shutil.rmtree(file) - else: - os.remove(file) - - -# Executes an external command -# stderr/stdout are hidden to avoid leaking credentials into log files in Travis, so it might be a pain in the butt to debug, sorry, but safety first! -# if exit_if_fail is set to True, this method will print minimal stacktrace information and exit if a failure is encountered, otherwise, an exception -# will be thrown (this is useful if an error will be handled by the invoking method) -def execute(command, error_message='Error encountered while executing command', exit_if_fail=True): - # do not print the command, stderr or stdout! this might expose usernames/passwords/tokens! - try: - subprocess.run(command, check=True, stderr=subprocess.DEVNULL, stdout=subprocess.DEVNULL) - except: - if exit_if_fail: - stack = traceback.extract_stack() - try: - print('{}\n Error originated at file {}, line {}'.format(error_message, stack[-2].filename, stack[-2].lineno), file=sys.stderr) - except: - print('{}\n No information about the originating call is available.'.format(error_message), file=sys.stderr) - exit(1) - else: - raise Exception() - - - -if __name__ == "__main__": - main() diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml deleted file mode 100644 index 6f92022..0000000 --- a/.github/workflows/build_docs.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: Build Documentation - -on: [push] - -jobs: - build: - - runs-on: ubuntu-latest - strategy: - matrix: - python: [3.7, 3.8] - - steps: - - uses: actions/checkout@v2 - name: Check out source-code repository - - - name: Setup Python - uses: actions/setup-python@v1 - with: - python-version: ${{ matrix.python }} - - - name: Install pip - run: | - python -m pip install --upgrade pip - - - name: Install doc dependencies - run: | - pip install -r docs/requirements.txt - - - name: Build docs - run: | - cd docs - make html - diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index f9a828d..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,23 +0,0 @@ -# .readthedocs.yml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/conf.py - -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml - -# Optionally build your docs in additional formats such as PDF and ePub -formats: all - -# Optionally set the version of Python and requirements required to build your docs -python: - version: 3.8 - install: - - requirements: docs/requirements.txt diff --git a/AUTHORS.rst b/AUTHORS.rst deleted file mode 100644 index 9b797b0..0000000 --- a/AUTHORS.rst +++ /dev/null @@ -1,13 +0,0 @@ -======= -Credits -======= - -Development Lead ----------------- - -* Steffen Greiner - -Contributors ------------- - -None yet. Why not be the first? diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 047c6a8..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = python -msphinx -SPHINXPROJ = xml-manager-lib -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) diff --git a/docs/_static/custom_cookietemple.css b/docs/_static/custom_cookietemple.css deleted file mode 100644 index 116126b..0000000 --- a/docs/_static/custom_cookietemple.css +++ /dev/null @@ -1,185 +0,0 @@ -@import "basic.css"; - -/*Color main components with a dark theme*/ -div, span, code { - background-color: #181a1b !important; -} - -.wy-side-nav-search { - background-color: #005fff !important; -} - -.wy-side-nav-search div { - background-color: #005fff !important; -} - -.wy-side-nav-search form { - background-color: #005fff !important; -} - -.wy-side-nav-search .wy-form input { - background-color: #2D2E2F !important; -} - -.wy-side-nav-search .wy-form input:focus { - background-color: #FFFFFF !important; - color: #000000 !important; -} - -::placeholder { /* Chrome, Firefox, Opera, Safari 10.1+ */ - color: white; - opacity: 1; /* Firefox */ -} - -/*Font color is mainly white*/ -.rst-content p, li, h1, h2, h3, h4, h5, h6, .highlight-console, .n, .section { - color: #FFFFFF; -} - -/*The side menu is slightly more grey and lighter than the overall theme*/ -.wy-menu, .wy-menu-vertical { - background-color: #2D2E2F !important; -} - -.wy-side-scroll { - background-color: #2D2E2F !important; -} - -.wy-menu .caption-text { - background-color: #2D2E2F !important; -} - -.caption-text { - background-color: #181a1b !important; -} - -.figure p { - background-color: #181a1b !important; -} - -/*Toctree wrapper on index page has a dark background unlike the other menu items*/ -.toctree-wrapper .compound ul .toctree-l1, .toctree-wrapper .compound ul .toctree-l2 { - background-color: #181a1b !important; - color: #005fff !important; -} - -/*The current menu section has a blue background*/ -.wy-menu-vertical li.toctree-l1.current li.toctree-l2 > a:hover { - color: #FFFFFF !important; - background: #005fff !important; -} - -/*Subitems under the current section are displayed in grey again*/ -.wy-menu-vertical li.toctree-l1.current li.toctree-l2 > a { - color: #FFFFFF !important; - background: #2D2E2F !important; -} - -/*Current hovered item has a blue background*/ -.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:hover { - color: #FFFFFF !important; - background: #005fff !important; -} - -.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a { - color: #FFFFFF !important; - background: #2D2E2F !important; -} - -.wy-menu-vertical li.toctree-l3.current li.toctree-l4 > a:hover { - color: #FFFFFF !important; - background: #005fff !important; -} - - -.wy-menu-vertical li.toctree-l2.current > a:hover { - color: #FFFFFF !important; - background: #005fff !important; -} - -.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a { - color: #FFFFFF !important; - background: #2D2E2F !important; -} - -.wy-menu-vertical li.toctree-l1.current { - color: #FFFFFF !important; - background: #005fff !important; - border-color: #005fff !important; -} - -.wy-menu-vertical li.toctree-l1.current > a { - color: #FFFFFF !important; - background: #005fff !important; - border-color: #005fff !important; -} - -.wy-menu-vertical li.toctree-l1.current > a:hover { - color: #FFFFFF !important; - background: #005fff !important; - border-color: #005fff !important; -} - -/*The expand toctree items have the same background as its corresponding section*/ -.wy-menu-vertical li.toctree-l1 a span.toctree-expand { - background-color: #005fff !important; -} - -.wy-menu-vertical li.toctree-l2 a span.toctree-expand { - background-color: #2D2E2F !important; -} - -.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand { - background-color: #005fff !important; -} - -.wy-menu-vertical li.toctree-l3 a span.toctree-expand { - background-color: #2D2E2F !important; -} - -.wy-menu-vertical li.toctree-l2.current a .toctree-expand { - background-color: #2D2E2F !important; - color: #FFFFFF !important; -} - -.wy-menu-vertical li.toctree-l2.current a:hover .toctree-expand { - background-color: #005fff !important; - color: #FFFFFF !important; -} - -.wy-menu-vertical li.toctree-l3.current a .toctree-expand { - background-color: #2D2E2F !important; - color: #FFFFFF !important; -} - -.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand { - background-color: #005fff !important; -} - -.code .docutils .literal .notranslate .pre { - background-color: #181a1b !important; -} - -/*Color footer separately corresponding to overall dark theme*/ -footer { - color: #FFFFFF; -} - -/*Color footer buttons in blue*/ -.rst-footer-buttons a, .rst-footer-buttons a:hover, .rst-footer-buttons span { - background-color: #005fff !important; -} - -.wy-side-nav-search a { - background-color: #005fff !important; -} - -.version { - background-color: #005fff !important; - color: #FFFFFF !important; -} - -/*Set max width to none so the theme uses all available width*/ -.wy-nav-content { - max-width: none; -} diff --git a/docs/authors.rst b/docs/authors.rst deleted file mode 100644 index e122f91..0000000 --- a/docs/authors.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../AUTHORS.rst diff --git a/docs/changelog.rst b/docs/changelog.rst deleted file mode 100644 index 565b052..0000000 --- a/docs/changelog.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CHANGELOG.rst diff --git a/docs/codeofconduct.rst b/docs/codeofconduct.rst deleted file mode 100644 index 53ca064..0000000 --- a/docs/codeofconduct.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CODEOFCONDUCT.rst diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index e874677..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,166 +0,0 @@ -#!/usr/bin/env python -# -# xml-manager-lib documentation build configuration file, created by -# sphinx-quickstart on Fri Jun 9 13:47:02 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# 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('..')) - -# -- 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. - -# Add 'sphinx_automodapi.automodapi' if you want to build modules -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] - -# 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' - -# General information about the project. -project = 'xml-manager-lib' -copyright = "2020, Steffen Greiner" -author = "Steffen Greiner" - -# The version info for the project you're documenting, acts as replacement -# for |version| and |release|, also used in various other places throughout -# the built documents. -# -# The short X.Y version. -version = '1.6.0-SNAPSHOT' -# The full version, including alpha/beta/rc tags. -release = '1.6.0-SNAPSHOT' - -# 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 patterns also effect to 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 = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- 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 = 'default' - -# 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'] - - -# -- Options for HTMLHelp output --------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'xml-manager-libdoc' - - -# -- 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, 'xml-manager-lib.tex', - 'xml-manager-lib Documentation', - 'Steffen Greiner', '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, 'xml-manager-lib', - 'xml-manager-lib 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, 'xml-manager-lib', - 'xml-manager-lib Documentation', - author, - 'xml-manager-lib', - 'One line description of project.', - 'Miscellaneous'), -] - -html_css_files = [ - 'custom_cookietemple.css' -] - - - diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index c6c5b5a..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -Welcome to xml-manager-lib's documentation! -============================================ -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - readme - installation - usage - authors - changelog - codeofconduct - -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 4ec94ea..0000000 --- a/docs/installation.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. highlight:: shell - -============ -Installation -============ - - -Stable release --------------- - -To install xml-manager-lib, run this command in your terminal: - -.. code-block:: console - - $ mvn install - -This is the preferred method to install xml-manager-lib, as it will always install the most recent stable release. - -If you don't have `maven`_ installed you can get it from `here`_ - -.. _maven: https://maven.apache.org/ -.. _here: https://maven.apache.org/ - -From sources ------------- - -The sources for xml-manager-lib can be downloaded from the `Github repo`_. - -You can either clone the public repository: - -.. code-block:: console - - $ git clone git://github.com/qbicsoftware/xml-manager-lib - -Or download the `tarball`_: - -.. code-block:: console - - $ curl -OJL https://github.com/qbicsoftware/xml-manager-lib/tarball/master - -Once you have a copy of the source, you can install it with: - -.. code-block:: console - - $ mvn install - - -.. _Github repo: https://github.com/qbicsoftware/xml-manager-lib -.. _tarball: https://github.com/qbicsoftware/xml-manager-lib/tarball/master diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 0e604e2..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,36 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=python -msphinx -) -set SOURCEDIR=. -set BUILDDIR=_build -set SPHINXPROJ=xml-manager-lib - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The Sphinx module was not found. Make sure you have Sphinx installed, - echo.then set the SPHINXBUILD environment variable to point to the full - echo.path of the 'sphinx-build' executable. Alternatively you may add the - echo.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 diff --git a/docs/readme.rst b/docs/readme.rst deleted file mode 100644 index 72a3355..0000000 --- a/docs/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 0bd797f..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -Sphinx==2.4.4 -sphinx-automodapi==0.12 diff --git a/docs/usage.rst b/docs/usage.rst deleted file mode 100644 index 9fc3a9e..0000000 --- a/docs/usage.rst +++ /dev/null @@ -1,13 +0,0 @@ -===== -Usage -===== - -To use xml-manager-lib in a project:: - - add it to the POM of the project that you like to include this project: - ``life.qbic - xml-manager-lib - 1.6.0-SNAPSHOT`` - - Include the library into your code by importing the respective classes into your project: - ``import package.path.to.class_name``