Skip to content

Commit

Permalink
use older version of sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
@cathydeng
cathydeng committed Mar 17, 2015
1 parent e352af0 commit 12c6d5c
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 130 deletions.
17 changes: 1 addition & 16 deletions docs/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

help:
@echo "Please use \`make <target>' where <target> is one of"
Expand All @@ -30,7 +30,6 @@ help:
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
Expand All @@ -46,7 +45,6 @@ help:
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"

clean:
rm -rf $(BUILDDIR)/*
Expand Down Expand Up @@ -91,14 +89,6 @@ qthelp:
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/probablepeople.qhc"

applehelp:
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
@echo
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
@echo "N.B. You won't be able to view it unless you put it in" \
"~/Library/Documentation/Help or install it in your application" \
"bundle."

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
Expand Down Expand Up @@ -176,11 +166,6 @@ doctest:
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

coverage:
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."

xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
Expand Down
48 changes: 12 additions & 36 deletions docs/conf.py
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
#
# probablepeople documentation build configuration file, created by
# sphinx-quickstart on Mon Mar 16 16:19:31 2015.
# sphinx-quickstart on Mon Mar 16 21:43:12 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
Expand All @@ -14,7 +14,6 @@

import sys
import os
import shlex

# 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
Expand All @@ -24,7 +23,7 @@
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.3'
#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
Expand All @@ -34,8 +33,8 @@
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
source_suffix = ['.rst']
# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'
Expand All @@ -46,7 +45,6 @@
# General information about the project.
project = u'probablepeople'
copyright = u'2015, Cathy Deng, Forest Gregg'
author = u'Cathy Deng, Forest Gregg'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -59,10 +57,7 @@

# 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
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -98,15 +93,12 @@
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False

# 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 = '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
Expand Down Expand Up @@ -183,23 +175,10 @@
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
#html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# Now only 'ja' uses this config value
#html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'probablepeopledoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
Expand All @@ -211,16 +190,13 @@

# 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, 'probablepeople.tex', u'probablepeople Documentation',
('index', 'probablepeople.tex', u'probablepeople Documentation',
u'Cathy Deng, Forest Gregg', 'manual'),
]

Expand Down Expand Up @@ -250,8 +226,8 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'probablepeople', u'probablepeople Documentation',
[author], 1)
('index', 'probablepeople', u'probablepeople Documentation',
[u'Cathy Deng, Forest Gregg'], 1)
]

# If true, show URL addresses after external links.
Expand All @@ -264,8 +240,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'probablepeople', u'probablepeople Documentation',
author, 'probablepeople', 'One line description of project.',
('index', 'probablepeople', u'probablepeople Documentation',
u'Cathy Deng, Forest Gregg', 'probablepeople', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
61 changes: 6 additions & 55 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
@@ -1,64 +1,15 @@
.. probablepeople documentation master file, created by
sphinx-quickstart on Mon Mar 16 16:19:31 2015.
sphinx-quickstart on Mon Mar 16 21:43:12 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
================
probablepeople |release|
================
Welcome to probablepeople's documentation!
==========================================

probablepeople is a python library for parsing unstructured romanized name strings into name components, using advanced NLP methods.
Contents:

Installation
============

.. code-block:: bash
pip install probablepeople
Usage
============
The ``parse`` method will split your name string into components, and label each component.
.. code:: python
>>> import probablepeople
>>> probablepeople.parse('Mr George "Gob" Bluth II')
[('Mr', 'PrefixMarital'),
('George', 'GivenName'),
('"Gob"', 'Nickname'),
('Bluth', 'Surname'),
('II', 'SuffixGenerational')]
Details
=======

probablepeople has the following labels for parsing names:

* PrefixMarital
* PrefixOther
* GivenName
* FirstInitial
* MiddleName
* MiddleInitial
* Surname
* LastInitial
* SuffixGenerational
* SuffixOther
* Nickname
* And


Important links
===============

* Documentation: http://probablepeople.rtfd.org/
* Repository: https://github.com/datamade/probablepeople
* Issues: https://github.com/datamade/probablepeople/issues
* Distribution: https://pypi.python.org/pypi/probablepeople
* Blog Post: http://datamade.us/blog/parse-name-or-parse-anything-really/
* Web Interface: http://parserator.datamade.us/probablepeople
.. toctree::
:maxdepth: 2



Expand Down
25 changes: 2 additions & 23 deletions docs/make.bat
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ if "%1" == "help" (
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
echo. coverage to run coverage check of the documentation if enabled
goto end
)

Expand All @@ -48,14 +47,6 @@ if "%1" == "clean" (
)


REM Check if sphinx-build is available and fallback to Python version if any
%SPHINXBUILD% 2> nul
if errorlevel 9009 goto sphinx_python
goto sphinx_ok

:sphinx_python

set SPHINXBUILD=python -m sphinx.__init__
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
Expand All @@ -69,9 +60,6 @@ if errorlevel 9009 (
exit /b 1
)

:sphinx_ok


if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
Expand Down Expand Up @@ -161,7 +149,7 @@ if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %~dp0
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
Expand All @@ -171,7 +159,7 @@ if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %~dp0
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
Expand Down Expand Up @@ -235,15 +223,6 @@ results in %BUILDDIR%/doctest/output.txt.
goto end
)

if "%1" == "coverage" (
%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
if errorlevel 1 exit /b 1
echo.
echo.Testing of coverage in the sources finished, look at the ^
results in %BUILDDIR%/coverage/python.txt.
goto end
)

if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
Expand Down

0 comments on commit 12c6d5c

Please sign in to comment.