Permalink
Browse files

no need for Sphinx in this package

  • Loading branch information...
1 parent 799f4d1 commit d6957d2055fb7ba4368e9465e1568d843ac0f4e9 @zupo zupo committed Dec 27, 2012
Showing with 3 additions and 256 deletions.
  1. +3 −13 Makefile
  2. +0 −28 docs/api.rst
  3. +0 −184 docs/conf.py
  4. +0 −8 docs/glossary.rst
  5. +0 −23 docs/index.rst
View
@@ -5,14 +5,7 @@ version = 2.7
python = bin/python
options =
-all: docs tests
-
-docs: docs/html/index.html
-
-docs/html/index.html: docs/*.rst src/niteoweb/ipn/core/*.py src/niteoweb/ipn/core/tests/*.py bin/sphinx-build
- bin/sphinx-build docs docs/html
- @touch $@
- @echo "Documentation was generated at '$@'."
+all: tests
coverage: htmlcov/index.html
@@ -22,9 +15,6 @@ htmlcov/index.html: src/niteoweb/ipn/core/*.py src/niteoweb/ipn/core/tests/*.py
@touch $@
@echo "Coverage report was generated at '$@'."
-bin/sphinx-build: .installed.cfg
- @touch $@
-
.installed.cfg: bin/buildout buildout.cfg buildout.d/*.cfg setup.py
bin/buildout $(options)
@@ -44,7 +34,7 @@ tests: .installed.cfg
@for zcml in `find src/niteoweb/ipn/core -name "*.zcml"` ; do bin/zptlint $$zcml; done
clean:
- @rm -rf .installed.cfg bin docs/html parts develop-eggs \
+ @rm -rf .installed.cfg bin parts develop-eggs htmlcov \
src/niteoweb.ipn.core.egg-info lib include .Python
-.PHONY: all docs tests clean
+.PHONY: all tests clean
View
@@ -1,28 +0,0 @@
-===
-API
-===
-
-
-Miscellaneous
-=============
-
-.. automodule:: niteoweb.ipn.core
- :members:
-
-----
-
-.. automodule:: niteoweb.ipn.core.interfaces
- :members:
-
-
-Tests
-=====
-
-.. automodule:: niteoweb.ipn.core.testing
- :members:
-
-----
-
-.. automodule:: niteoweb.ipn.core.tests.test_setup
- :members:
-
View
@@ -1,184 +0,0 @@
-# -*- coding: utf-8 -*-
-# niteoweb.plr documentation build configuration file, created by
-# sphinx-quickstart on Mon Feb 8 19:10:04 2010.
-# 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.
-#sys.path.append(os.path.abspath('.'))
-
-# -- 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.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-from datetime import datetime
-project = u'niteoweb.ipn.core'
-copyright = u'%s, NiteoWeb Ltd..' % datetime.now().year
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = []
-
-# The reST default role (used for this markup: `text`) to use for all documents
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
-
-
-# -- Options for HTML output --------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-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 themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# 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']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'ipndoc'
-
-
-# -- Options for LaTeX output -------------------------------------------------
-
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual])
-latex_documents = [
- ('index',
- 'ipn.tex',
- u'niteoweb.ipn.core Documentation',
- u'', 'manual'
- ),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
View
@@ -1,8 +0,0 @@
-Definitions of basic terms
-==========================
-
-.. glossary::
-
- First Item
- Explain first item and add more.
-
View
@@ -1,23 +0,0 @@
-.. include:: ../README.rst
-
-
-Developer documentation
-=======================
-
-.. toctree::
- :maxdepth: 2
-
- api.rst
- glossary.rst
-
-
-.. include:: CHANGELOG.rst
-.. include:: LICENSE.rst
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

0 comments on commit d6957d2

Please sign in to comment.