From 79de661ae7e9d0bdb145b098c8d11226cfe75354 Mon Sep 17 00:00:00 2001 From: chang-ning Date: Thu, 3 Mar 2016 07:53:19 +0800 Subject: [PATCH] Change docs FHS --- .gitignore | 2 +- docs/Makefile | 14 +++++++------- docs/{source => }/_static/.gitignore | 0 docs/{source => }/conf.py | 0 docs/{source => }/index.rst | 0 docs/{source => }/notes/python-asyncio.rst | 0 docs/{source => }/notes/python-basic.rst | 0 docs/{source => }/notes/python-capi.rst | 0 docs/{source => }/notes/python-concurrency.rst | 0 docs/{source => }/notes/python-cstyle.rst | 0 docs/{source => }/notes/python-generator.rst | 0 docs/{source => }/notes/python-rexp.rst | 0 docs/{source => }/notes/python-socket.rst | 0 docs/{source => }/notes/python-tests.rst | 0 14 files changed, 8 insertions(+), 8 deletions(-) rename docs/{source => }/_static/.gitignore (100%) rename docs/{source => }/conf.py (100%) rename docs/{source => }/index.rst (100%) rename docs/{source => }/notes/python-asyncio.rst (100%) rename docs/{source => }/notes/python-basic.rst (100%) rename docs/{source => }/notes/python-capi.rst (100%) rename docs/{source => }/notes/python-concurrency.rst (100%) rename docs/{source => }/notes/python-cstyle.rst (100%) rename docs/{source => }/notes/python-generator.rst (100%) rename docs/{source => }/notes/python-rexp.rst (100%) rename docs/{source => }/notes/python-socket.rst (100%) rename docs/{source => }/notes/python-tests.rst (100%) diff --git a/.gitignore b/.gitignore index 346dd5e8..d6733e1c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ *.swp *.pyc -docs/build/ +_build/ diff --git a/docs/Makefile b/docs/Makefile index 30bde125..e8243286 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = build +BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) @@ -15,9 +15,9 @@ endif # 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 help: @@ -94,9 +94,9 @@ qthelp: @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-cheatsheet.qhcp" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pysheeet.qhcp" @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-cheatsheet.qhc" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pysheeet.qhc" .PHONY: applehelp applehelp: @@ -113,8 +113,8 @@ devhelp: @echo @echo "Build finished." @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/python-cheatsheet" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-cheatsheet" + @echo "# mkdir -p $$HOME/.local/share/devhelp/pysheeet" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pysheeet" @echo "# devhelp" .PHONY: epub diff --git a/docs/source/_static/.gitignore b/docs/_static/.gitignore similarity index 100% rename from docs/source/_static/.gitignore rename to docs/_static/.gitignore diff --git a/docs/source/conf.py b/docs/conf.py similarity index 100% rename from docs/source/conf.py rename to docs/conf.py diff --git a/docs/source/index.rst b/docs/index.rst similarity index 100% rename from docs/source/index.rst rename to docs/index.rst diff --git a/docs/source/notes/python-asyncio.rst b/docs/notes/python-asyncio.rst similarity index 100% rename from docs/source/notes/python-asyncio.rst rename to docs/notes/python-asyncio.rst diff --git a/docs/source/notes/python-basic.rst b/docs/notes/python-basic.rst similarity index 100% rename from docs/source/notes/python-basic.rst rename to docs/notes/python-basic.rst diff --git a/docs/source/notes/python-capi.rst b/docs/notes/python-capi.rst similarity index 100% rename from docs/source/notes/python-capi.rst rename to docs/notes/python-capi.rst diff --git a/docs/source/notes/python-concurrency.rst b/docs/notes/python-concurrency.rst similarity index 100% rename from docs/source/notes/python-concurrency.rst rename to docs/notes/python-concurrency.rst diff --git a/docs/source/notes/python-cstyle.rst b/docs/notes/python-cstyle.rst similarity index 100% rename from docs/source/notes/python-cstyle.rst rename to docs/notes/python-cstyle.rst diff --git a/docs/source/notes/python-generator.rst b/docs/notes/python-generator.rst similarity index 100% rename from docs/source/notes/python-generator.rst rename to docs/notes/python-generator.rst diff --git a/docs/source/notes/python-rexp.rst b/docs/notes/python-rexp.rst similarity index 100% rename from docs/source/notes/python-rexp.rst rename to docs/notes/python-rexp.rst diff --git a/docs/source/notes/python-socket.rst b/docs/notes/python-socket.rst similarity index 100% rename from docs/source/notes/python-socket.rst rename to docs/notes/python-socket.rst diff --git a/docs/source/notes/python-tests.rst b/docs/notes/python-tests.rst similarity index 100% rename from docs/source/notes/python-tests.rst rename to docs/notes/python-tests.rst