Cleanup Python project

This commit is contained in:
Timo Furrer
2019-08-24 22:53:43 +02:00
parent 260f0d54eb
commit a4432eef31
37 changed files with 812 additions and 646 deletions
View File
View File
+32 -33
View File
@@ -19,11 +19,12 @@
#
import os
import sys
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('_themes'))
import maya
# sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath(".."))
sys.path.insert(0, os.path.abspath("_themes"))
import maya # noqa
# -- General configuration ------------------------------------------------
@@ -34,27 +35,29 @@ import maya
# 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.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode']
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.viewcode",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
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'
source_suffix = ".rst"
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = 'maya'
copyright = '2017, Kenneth Reitz'
author = 'Kenneth Reitz'
project = "maya"
copyright = "2017, Kenneth Reitz"
author = "Kenneth Reitz"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -78,7 +81,7 @@ language = None
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
@@ -89,7 +92,7 @@ todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
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
@@ -100,13 +103,13 @@ html_theme = 'alabaster'
# 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 = ["_static"]
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'mayadoc'
htmlhelp_basename = "mayadoc"
# -- Options for LaTeX output ---------------------------------------------
@@ -115,15 +118,12 @@ 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',
@@ -133,8 +133,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'maya.tex', 'maya Documentation',
'Kenneth Reitz', 'manual'),
(master_doc, "maya.tex", "maya Documentation", "Kenneth Reitz", "manual")
]
@@ -142,10 +141,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'maya', 'maya Documentation',
[author], 1)
]
man_pages = [(master_doc, "maya", "maya Documentation", [author], 1)]
# -- Options for Texinfo output -------------------------------------------
@@ -154,10 +150,13 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'maya', 'maya Documentation',
author, 'maya', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"maya",
"maya Documentation",
author,
"maya",
"One line description of project.",
"Miscellaneous",
)
]
-1
View File
@@ -80,4 +80,3 @@ Table of Contents
user/install
user/quickstart
View File
+2 -3
View File
@@ -1,6 +1,7 @@
.. _install:
Installation
=============
============
Pip Install Maya
----------------
@@ -26,5 +27,3 @@ Once you have a copy of the source, you can embed it in your own Python
package, or install it into your site-packages easily::
$ python setup.py install
View File
+1 -9
View File
@@ -1,4 +1,5 @@
.. _quickstart:
Quickstart
==========
@@ -7,12 +8,6 @@ Quickstart
Ready for a simple datetime tool? This doc provides some tools to use in your
busy workflow.
First, make sure that Maya is:
- :ref:`Installed <install>`
- :ref:`Up to date <update>`
Parse a Date
------------
Parsing a date from a string with Maya is 🍰!
@@ -33,6 +28,3 @@ Use as follows::
>>> recent_win = maya.parse('2016-11-02T20:00PM')
>>> old_win = maya.when('October 14, 1908')
>>> grandpas_date = maya.when('108 years ago')
-27
View File
@@ -1,27 +0,0 @@
.. _update:
Community Updates
=================
If you'd like to stay up to date on the community and development of Maya,
there are several options:
GitHub
------
The best way to track the development of Maya is through
`the GitHub repo <https://github.com/kennethreitz/Maya>`_.
Twitter
-------
The author, Kenneth Reitz, often tweets about new features and releases of Maya.
Follow `@kennethreitz <https://twitter.com/kennethreitz>`_ for updates.
Release and Version History
===========================
.. include:: ../../HISTORY.rst