Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 5 additions & 65 deletions documentation/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,78 +1,18 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- 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('../sphinx-extensions/sphinxcontrib'))

import dylan.domain
import dylan.themes as dylan_themes



# -- Project information -----------------------------------------------------
sys.path.insert(0, os.path.abspath('../../_packages/sphinx-extensions/current/src/sphinxcontrib'))

project = 'command-line-parser'
copyright = '2022, Dylan Hackers'
author = 'Dylan Hackers'

# The full version, including alpha/beta/rc tags
release = 'v3.2.0'


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
exclude_patterns = ['_build']
primary_domain = 'dylan'
html_theme = 'furo' # sudo pip install furo
html_title = 'command-line-parser'
extensions = [
'dylan.domain',
'sphinx.ext.intersphinx'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# 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']

# This makes it so that each document doesn't have to use
# .. default-domain:: dylan
# but they probably should anyway, so that they can be built separately
# without depending on this top-level config file.
primary_domain = 'dylan'

# -- 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 = dylan_themes.get_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 = dylan_themes.get_html_theme_options_default()

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [dylan_themes.get_html_theme_path()]

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = "Dylan Library Reference"

# 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']
17 changes: 8 additions & 9 deletions documentation/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
*******************************
The command-line-parser Library
*******************************
*******************
command-line-parser
*******************

.. current-library:: command-line-parser
.. current-module:: command-line-parser

.. contents:: Contents
:local:
.. toctree::


The *command-line-parser* library provides a facility to parse the
Expand Down Expand Up @@ -151,8 +150,8 @@ Reference
=========


The command-line-parser Module
------------------------------
Module: command-line-parser
---------------------------

.. class:: <command>
:abstract:
Expand Down Expand Up @@ -714,8 +713,8 @@ Option Classes
of the default one.


The option-parser-protocol Module
---------------------------------
Module: option-parser-protocol
------------------------------

This module exports an API that can be used to extend the existing command line
parser without modifying the source in this library. It shouldn't be common to
Expand Down
1 change: 1 addition & 0 deletions dylan-package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"[email protected]"
],
"dev-dependencies": [
"sphinx-extensions",
"[email protected]"
]
}