diff --git a/.gitignore b/.gitignore index 6a44ebf4..1f303fe4 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,6 @@ .ropeproject *.pyc /build/ -/docs/build/ +/docs/_build/ /dist/ jedi.egg-info/ diff --git a/README.rst b/README.rst index b00267a0..1acd8513 100644 --- a/README.rst +++ b/README.rst @@ -29,15 +29,15 @@ Jedi for now, you'll have to use VIM. But there are new plugins emerging: Here are some pictures: -.. image:: https://github.com/davidhalter/jedi/raw/master/docs/source/screenshot_complete.png +.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_complete.png Completion for almost anything (Ctrl+Space). -.. image:: https://github.com/davidhalter/jedi/raw/master/docs/source/screenshot_function.png +.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_function.png Display of function/class bodies, docstrings. -.. image:: https://github.com/davidhalter/jedi/raw/master/docs/source/screenshot_pydoc.png +.. image:: https://github.com/davidhalter/jedi/raw/master/docs/_screenshots/screenshot_pydoc.png Pydoc support (with highlighting, Shift+k). diff --git a/docs/Makefile b/docs/Makefile index 62c5845a..14cfdf4b 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,14 +5,14 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = build +BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext diff --git a/docs/source/screenshot_complete.png b/docs/_screenshots/screenshot_complete.png similarity index 100% rename from docs/source/screenshot_complete.png rename to docs/_screenshots/screenshot_complete.png diff --git a/docs/source/screenshot_function.png b/docs/_screenshots/screenshot_function.png similarity index 100% rename from docs/source/screenshot_function.png rename to docs/_screenshots/screenshot_function.png diff --git a/docs/source/screenshot_pydoc.png b/docs/_screenshots/screenshot_pydoc.png similarity index 100% rename from docs/source/screenshot_pydoc.png rename to docs/_screenshots/screenshot_pydoc.png diff --git a/docs/source/_static/logo.png b/docs/_static/logo.png similarity index 100% rename from docs/source/_static/logo.png rename to docs/_static/logo.png diff --git a/docs/source/_templates/ghbuttons.html b/docs/_templates/ghbuttons.html similarity index 100% rename from docs/source/_templates/ghbuttons.html rename to docs/_templates/ghbuttons.html diff --git a/docs/source/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html similarity index 100% rename from docs/source/_templates/sidebarlogo.html rename to docs/_templates/sidebarlogo.html diff --git a/docs/source/_themes/flask/LICENSE b/docs/_themes/flask/LICENSE similarity index 100% rename from docs/source/_themes/flask/LICENSE rename to docs/_themes/flask/LICENSE diff --git a/docs/source/_themes/flask/layout.html b/docs/_themes/flask/layout.html similarity index 100% rename from docs/source/_themes/flask/layout.html rename to docs/_themes/flask/layout.html diff --git a/docs/source/_themes/flask/relations.html b/docs/_themes/flask/relations.html similarity index 100% rename from docs/source/_themes/flask/relations.html rename to docs/_themes/flask/relations.html diff --git a/docs/source/_themes/flask/static/flasky.css_t b/docs/_themes/flask/static/flasky.css_t similarity index 100% rename from docs/source/_themes/flask/static/flasky.css_t rename to docs/_themes/flask/static/flasky.css_t diff --git a/docs/source/_themes/flask/static/small_flask.css b/docs/_themes/flask/static/small_flask.css similarity index 100% rename from docs/source/_themes/flask/static/small_flask.css rename to docs/_themes/flask/static/small_flask.css diff --git a/docs/source/_themes/flask/theme.conf b/docs/_themes/flask/theme.conf similarity index 100% rename from docs/source/_themes/flask/theme.conf rename to docs/_themes/flask/theme.conf diff --git a/docs/source/_themes/flask_theme_support.py b/docs/_themes/flask_theme_support.py similarity index 100% rename from docs/source/_themes/flask_theme_support.py rename to docs/_themes/flask_theme_support.py diff --git a/docs/source/conf.py b/docs/conf.py similarity index 98% rename from docs/source/conf.py rename to docs/conf.py index b06cf7bb..614ecef1 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -16,8 +16,8 @@ import sys, os, datetime # 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.insert(0, os.path.abspath('../..')) -sys.path.insert(0, os.path.abspath('../../jedi')) +sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath('../jedi')) sys.path.append(os.path.abspath('_themes')) # -- General configuration ----------------------------------------------------- @@ -46,7 +46,7 @@ project = u'Jedi' copyright = u'2012 - {today.year}, Jedi contributors'.format(today=datetime.date.today()) _path = os.path.dirname(os.path.abspath(__file__)) -with open(_path + '/../../VERSION') as f: +with open(os.path.join(_path, '../VERSION'), 'r') as f: VERSION = f.read().strip() # The version info for the project you're documenting, acts as replacement for diff --git a/docs/source/installation.rst b/docs/docs/installation.rst similarity index 100% rename from docs/source/installation.rst rename to docs/docs/installation.rst diff --git a/docs/source/plugin-api.rst b/docs/docs/plugin-api.rst similarity index 100% rename from docs/source/plugin-api.rst rename to docs/docs/plugin-api.rst diff --git a/docs/source/index.rst b/docs/index.rst similarity index 81% rename from docs/source/index.rst rename to docs/index.rst index 4d79d3cb..69194e69 100644 --- a/docs/source/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ Jedi ==== -Release v\ |version|. (:doc:`Installation `) +Release v\ |release|. (:doc:`Installation `) .. automodule:: jedi :members: @@ -9,7 +9,7 @@ Release v\ |version|. (:doc:`Installation `) Autocompletion can look like this (e.g. VIM plugin): -.. figure:: screenshot_complete.png +.. figure:: _screenshots/screenshot_complete.png Docs @@ -18,8 +18,8 @@ Docs .. toctree:: :maxdepth: 1 - installation - plugin-api + docs/installation + docs/plugin-api Resources