From f54f7f24fd0c9138ea89935e188f61c909e52096 Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 8 Sep 2017 23:40:05 -0400 Subject: [PATCH] Sphinx (#200) * Fix Parameters typo * Almost working documentation generation * Remove genarted html files, update conf and index * Update docs/conf.py * Add docs/source files * Prevent creation of modules.rst; update index.rst * Move conf.py and index.rst to docs/source * Add opening paragraph to index.rst * Fix flake8 issues --- buku.py | 2 +- docs/source/buku.rst | 7 ++ docs/source/conf.py | 175 ++++++++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 22 ++++++ 4 files changed, 205 insertions(+), 1 deletion(-) create mode 100644 docs/source/buku.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst diff --git a/buku.py b/buku.py index cfed751..0fb15dd 100755 --- a/buku.py +++ b/buku.py @@ -672,7 +672,7 @@ class BukuDb: def add_rec(self, url, title_in=None, tags_in=None, desc=None, immutable=0, delay_commit=False): """Add a new bookmark - Paramaters + Parameters ---------- url : str URL to bookmark diff --git a/docs/source/buku.rst b/docs/source/buku.rst new file mode 100644 index 0000000..e89ff25 --- /dev/null +++ b/docs/source/buku.rst @@ -0,0 +1,7 @@ +buku module +=========== + +.. automodule:: buku + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..c92ec0d --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,175 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Buku documentation build configuration file, created by +# sphinx-quickstart on Thu Sep 7 12:54:59 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('../../')) +# 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. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.viewcode', + 'sphinx.ext.autosummary', + 'sphinx.ext.napoleon'] + +# 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 = 'Buku' +copyright = '2017, Arun Prakash Jana' +author = 'Arun Prakash Jana' + +# 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 = '' +# The full version, including alpha/beta/rc tags. +release = '' + +# 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 = 'alabaster' +html_theme = "sphinx_rtd_theme" + +# 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'] +html_static_path = [] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Bukudoc' + + +# -- 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, 'Buku.tex', 'Buku Documentation', + 'Arun Prakash Jana', '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, 'buku', 'Buku 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, 'Buku', 'Buku Documentation', + author, 'Buku', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..39222ea --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,22 @@ +.. Buku documentation master file, created by + sphinx-quickstart on Thu Sep 7 12:54:59 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Buku +==== + +`buku `_ is a powerful bookmark manager written in Python3 and SQLite3. When I started writing it, I couldn’t find a flexible cmdline solution with a private, portable, merge-able database along with browser integration. Hence, Buku (after my son’s nickname, meaning close to the heart in my language). + +.. toctree:: + :maxdepth: 2 + :caption: Table of Contents + + Buku + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`