diff --git a/doc/Slides.rst b/doc/Slides.rst new file mode 100644 index 0000000..825481d --- /dev/null +++ b/doc/Slides.rst @@ -0,0 +1,62 @@ +Slides package +============== + +Submodules +---------- + +Slides.cell\_manager module +--------------------------- + +.. automodule:: Slides.cell_manager + :members: + :undoc-members: + :show-inheritance: + +Slides.count\_slides module +--------------------------- + +.. automodule:: Slides.count_slides + :members: + :undoc-members: + :show-inheritance: + +Slides.inject\-markdown module +------------------------------ + +.. automodule:: Slides.inject-markdown + :members: + :undoc-members: + :show-inheritance: + +Slides.math\_helper module +-------------------------- + +.. automodule:: Slides.math_helper + :members: + :undoc-members: + :show-inheritance: + +Slides.presentation\_helper module +---------------------------------- + +.. automodule:: Slides.presentation_helper + :members: + :undoc-members: + :show-inheritance: + +Slides.snippet\_helper module +----------------------------- + +.. automodule:: Slides.snippet_helper + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: Slides + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..bbdaf8b --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,169 @@ +# -*- 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('../Slides')) + + +# -- Project information ----------------------------------------------------- + +project = u'Slides' +copyright = u'2018, Guillaume Anciaux' +author = u'Guillaume Anciaux' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'1.0' + + +# -- 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.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + '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' + +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- 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' + +# 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 = 'Slidesdoc' + + +# -- 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, 'Slides.tex', u'Slides Documentation', + u'Guillaume Anciaux', '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, 'slides', u'Slides 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, 'Slides', u'Slides Documentation', + author, 'Slides', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..58ca6b4 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,22 @@ +.. Slides documentation master file, created by + sphinx-quickstart on Sun Nov 11 22:32:21 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Slides's documentation! +================================== + +.. toctree:: + :maxdepth: 3 + + modules + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + + diff --git a/doc/modules.rst b/doc/modules.rst new file mode 100644 index 0000000..3d35db5 --- /dev/null +++ b/doc/modules.rst @@ -0,0 +1,7 @@ +Slides +====== + +.. toctree:: + :maxdepth: 4 + + Slides diff --git a/setup.py b/setup.py index 7fb6528..b438acb 100644 --- a/setup.py +++ b/setup.py @@ -1,26 +1,38 @@ from setuptools import setup, find_packages +from sphinx.setup_command import BuildDoc -setup(name="slides", +name = 'slides' +version = '1.0' +release = '1.0.0' + +setup(name=name, packages=find_packages(), version="0.0.1", author="Guillaume Anciaux", author_email="guillaume.anciaux@epfl.ch", description=("Slides making/convertion tools"), scripts=['scripts/slides'], tests_require=["pytest"], setup_requires=["pytest-runner"], test_suite="tests", + cmdclass={'doc': BuildDoc}, + command_options={ + 'doc': { + 'project': ('setup.py', name), + 'version': ('setup.py', version), + 'release': ('setup.py', release), + 'source_dir': ('setup.py', 'doc')}}, license=""" This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . """)