diff options
| -rw-r--r-- | doc/.gitignore | 1 | ||||
| -rw-r--r-- | doc/Makefile | 42 | ||||
| -rw-r--r-- | doc/source/conf.py (renamed from doc/conf.py) | 8 | ||||
| -rw-r--r-- | doc/source/index.rst (renamed from doc/index.rst) | 0 | ||||
| -rw-r--r-- | doc/source/intro.rst (renamed from doc/intro.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference.rst (renamed from doc/reference.rst) | 0 | ||||
| -rw-r--r-- | doc/source/roadmap.rst (renamed from doc/roadmap.rst) | 0 | ||||
| -rw-r--r-- | doc/source/tutorial.rst (renamed from doc/tutorial.rst) | 0 | ||||
| -rw-r--r-- | doc/source/whatsnew.rst (renamed from doc/whatsnew.rst) | 4 |
9 files changed, 28 insertions, 27 deletions
diff --git a/doc/.gitignore b/doc/.gitignore new file mode 100644 index 00000000..567609b1 --- /dev/null +++ b/doc/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/doc/Makefile b/doc/Makefile index dbc6dec2..39fe377f 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -9,7 +9,7 @@ PAPER = # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html web pickle htmlhelp latex changes linkcheck @@ -24,52 +24,52 @@ help: @echo " linkcheck to check all external links for integrity" clean: - -rm -rf _build/* + -rm -rf build/* html: - mkdir -p _build/html _build/doctrees - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html + mkdir -p build/html build/doctrees + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html @echo - @echo "Build finished. The HTML pages are in _build/html." + @echo "Build finished. The HTML pages are in build/html." pickle: - mkdir -p _build/pickle _build/doctrees - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle + mkdir -p build/pickle build/doctrees + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle @echo @echo "Build finished; now you can process the pickle files." web: pickle json: - mkdir -p _build/json _build/doctrees - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json + mkdir -p build/json build/doctrees + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: - mkdir -p _build/htmlhelp _build/doctrees - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp + mkdir -p build/htmlhelp build/doctrees + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in _build/htmlhelp." + ".hhp project file in build/htmlhelp." latex: - mkdir -p _build/latex _build/doctrees - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex + mkdir -p build/latex build/doctrees + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex @echo - @echo "Build finished; the LaTeX files are in _build/latex." + @echo "Build finished; the LaTeX files are in build/latex." @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ "run these through (pdf)latex." changes: - mkdir -p _build/changes _build/doctrees - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes + mkdir -p build/changes build/doctrees + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes @echo - @echo "The overview file is in _build/changes." + @echo "The overview file is in build/changes." linkcheck: - mkdir -p _build/linkcheck _build/doctrees - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck + mkdir -p build/linkcheck build/doctrees + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ - "or in _build/linkcheck/output.txt." + "or in build/linkcheck/output.txt." diff --git a/doc/conf.py b/doc/source/conf.py index 766ecb75..21304eaa 100644 --- a/doc/conf.py +++ b/doc/source/conf.py @@ -20,7 +20,7 @@ import sys, os # is relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. #sys.path.append(os.path.abspath('.')) -sys.path.insert(0, os.path.abspath('../lib')) +sys.path.insert(0, os.path.abspath('../../lib')) # General configuration # --------------------- @@ -30,7 +30,7 @@ sys.path.insert(0, os.path.abspath('../lib')) extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['templates'] +templates_path = ['.templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -69,7 +69,7 @@ release = '0.3.0 Beta 1' # List of directories, relative to source directory, that shouldn't be searched # for source files. -exclude_trees = ['_build'] +exclude_trees = ['build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -120,7 +120,7 @@ html_style = 'default.css' # 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'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/doc/index.rst b/doc/source/index.rst index 6bb8d1fe..6bb8d1fe 100644 --- a/doc/index.rst +++ b/doc/source/index.rst diff --git a/doc/intro.rst b/doc/source/intro.rst index c96766fb..c96766fb 100644 --- a/doc/intro.rst +++ b/doc/source/intro.rst diff --git a/doc/reference.rst b/doc/source/reference.rst index 5952fe2d..5952fe2d 100644 --- a/doc/reference.rst +++ b/doc/source/reference.rst diff --git a/doc/roadmap.rst b/doc/source/roadmap.rst index a6bdc3a0..a6bdc3a0 100644 --- a/doc/roadmap.rst +++ b/doc/source/roadmap.rst diff --git a/doc/tutorial.rst b/doc/source/tutorial.rst index 033bbad4..033bbad4 100644 --- a/doc/tutorial.rst +++ b/doc/source/tutorial.rst diff --git a/doc/whatsnew.rst b/doc/source/whatsnew.rst index 9a49e0b9..7a5ef53d 100644 --- a/doc/whatsnew.rst +++ b/doc/source/whatsnew.rst @@ -4,7 +4,7 @@ Whats New in 0.3 ################ GitPython 0.3 is the first step in creating a hybrid which uses a pure python implementations for all simple git features which can be implemented without significant performance penalties. Everything else is still performed using the git command, which is nicely integrated and easy to use. -Its biggest strength, being the support for all git features through the git command itself, is a weakness as well considering the possibly vast amount of times the git command is being started up. Depending on the actual command being performaned, the git repository will be initialized on many of these invocations, causing additional overhead for possibly tiny operations. +Its biggest strength, being the support for all git features through the git command itself, is a weakness as well considering the possibly vast amount of times the git command is being started up. Depending on the actual command being performed, the git repository will be initialized on many of these invocations, causing additional overhead for possibly tiny operations. Keeping as many major operations in the python world will result in improved caching benefits as certain data structures just have to be initialized once and can be reused multiple times. This mode of operation may improve performance when altering the git database on a low level, and is clearly beneficial on operating systems where command invocations are very slow. @@ -33,7 +33,7 @@ GitPython 0.2 essentially behaves like GitPython 0.3 with a Repository using the Why you should not upgrade ************************** GitPython 0.3 in most cases will not run faster than GitPython 0.2, the opposite might be the case at it uses the pure python implementation by default. -There have been a few renames which will need additional adjustments by your code. +There have been a few renames which will need additional adjustments in your code. Generally, if you only read git repositories, version 0.2 is sufficient and very well performing. |