Merge pull request #6970 from phadej/move-doc-to-top

Move doc/ to the top-level of the repository
haskell · Jul 16, 2020 · 7118ea0 · 7118ea0
2 parents d8f890b + 2cb296d
commit 7118ea0
Show file tree

Hide file tree

Showing 35 changed files with 29 additions and 27 deletions.
diff --git a/.gitignore b/.gitignore
@@ -15,9 +15,9 @@ dist-*
 register.sh
 ./cabal.config
 cabal-tests.log
+.python-sphinx-virtualenv/
 
 /Cabal/dist/
-/Cabal/.python-sphinx-virtualenv/
 /Cabal/tests/Setup
 /Cabal/Setup
 /Cabal/source-file-list

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,9 +1,9 @@
 version: 2
 
 sphinx:
-  configuration: Cabal/doc/conf.py
+  configuration: doc/conf.py
 
 python:
   version: 3.7
   install:
-    - requirements: Cabal/doc/requirements.txt
+    - requirements: doc/requirements.txt
diff --git a/Cabal/Makefile b/Cabal/Makefile
@@ -20,14 +20,10 @@ SOURCES=Distribution/*.hs Distribution/Simple/*.hs \
 CONFIG_STAMP=dist/setup-config
 BUILD_STAMP=dist/build/libHSCabal-$(VERSION).a
 HADDOCK_STAMP=dist/doc/html/Cabal/index.html
-USERGUIDE_STAMP=dist/doc/users-guide/index.html
 SDIST_STAMP=dist/Cabal-$(VERSION).tar.gz
 DISTLOC=dist/release
 DIST_STAMP=$(DISTLOC)/Cabal-$(VERSION).tar.gz
 
-# TODO: when we have sphinx-build2 ?
-SPHINXCMD:=sphinx-build
-
 COMMA=,
 
 setup: $(SOURCES) Setup.hs
@@ -51,20 +47,6 @@ haddock: $(HADDOCK_STAMP)
 $(HADDOCK_STAMP) : $(CONFIG_STAMP) $(BUILD_STAMP)
 	./setup haddock
 
-SPHINX_HTML_OUTDIR=dist/doc/users-guide
-
-# do pip install everytime so we have up to date requirements when we build
-users-guide: .python-sphinx-virtualenv $(USERGUIDE_STAMP)
-$(USERGUIDE_STAMP) : doc/*.rst
-	mkdir -p $(SPHINX_HTML_OUTDIR)
-	(. ./.python-sphinx-virtualenv/bin/activate && pip install -r doc/requirements.txt && $(SPHINXCMD) doc $(SPHINX_HTML_OUTDIR))
-
-docs: haddock users-guide
-
-.python-sphinx-virtualenv:
-	python3 -m venv .python-sphinx-virtualenv
-	(. ./.python-sphinx-virtualenv/bin/activate)
-
 clean:
 	rm -rf dist/
 	rm -f setup
@@ -93,17 +75,15 @@ $(SDIST_STAMP) : $(BUILD_STAMP)
 	./setup sdist
 
 dist: $(DIST_STAMP)
-$(DIST_STAMP) : $(HADDOCK_STAMP) $(USERGUIDE_STAMP) $(SDIST_STAMP)
+$(DIST_STAMP) : $(HADDOCK_STAMP) $(SDIST_STAMP)
 	rm -rf $(DISTLOC)
 	mkdir $(DISTLOC)
 	tar -xzf $(SDIST_STAMP) -C $(DISTLOC)/
 	mkdir -p $(DISTLOC)/Cabal-$(VERSION)/doc
 	cp -r dist/doc/html $(DISTLOC)/Cabal-$(VERSION)/doc/API
-	cp -r dist/doc/users-guide $(DISTLOC)/Cabal-$(VERSION)/doc/
 	cp ChangeLog.md $(DISTLOC)/Cabal-$(VERSION)/
 	tar --format=ustar -C $(DISTLOC) -czf $(DISTLOC)/Cabal-$(VERSION).tar.gz Cabal-$(VERSION)
 	mkdir $(DISTLOC)/doc
-	mv $(DISTLOC)/Cabal-$(VERSION)/doc/users-guide $(DISTLOC)/doc
 	mv $(DISTLOC)/Cabal-$(VERSION)/doc/API $(DISTLOC)/doc
 	mv $(DISTLOC)/Cabal-$(VERSION)/ChangeLog.md $(DISTLOC)/
 	rm -r $(DISTLOC)/Cabal-$(VERSION)/

diff --git a/Makefile b/Makefile
@@ -58,7 +58,7 @@ $(TEMPLATE_MACROS) : boot/cabal_macros.template.h cabal-dev-scripts/src/GenCabal
 
 # generated docs
 
-Cabal/doc/buildinfo-fields-reference.rst : phony
+doc/buildinfo-fields-reference.rst : phony
 	cabal build --builddir=dist-newstyle-bi --project-file=cabal.project.buildinfo buildinfo-reference-generator
 	$$(cabal-plan list-bin --builddir=dist-newstyle-bi buildinfo-reference-generator) buildinfo-reference-generator/template.zinza | tee $@
 
@@ -226,3 +226,25 @@ weeder :
 .PHONY : tags
 tags :
 	hasktags -b Cabal/Distribution Cabal/Cabal-described/src Cabal/Language cabal-install/Distribution cabal-testsuite/src
+
+# documentation
+##############################################################################
+
+# TODO: when we have sphinx-build2 ?
+SPHINXCMD:=sphinx-build
+SPHINX_HTML_OUTDIR:=dist-newstyle/doc/users-guide
+USERGUIDE_STAMP:=$(SPHINX_HTML_OUTDIR)/index.html
+
+# do pip install everytime so we have up to date requirements when we build
+users-guide: .python-sphinx-virtualenv $(USERGUIDE_STAMP)
+$(USERGUIDE_STAMP) : doc/*.rst
+	mkdir -p $(SPHINX_HTML_OUTDIR)
+	(. ./.python-sphinx-virtualenv/bin/activate && pip install -r doc/requirements.txt && $(SPHINXCMD) doc $(SPHINX_HTML_OUTDIR))
+
+docs: haddock users-guide
+
+.python-sphinx-virtualenv:
+	python3 -m venv .python-sphinx-virtualenv
+	(. ./.python-sphinx-virtualenv/bin/activate)
+
+
diff --git a/Cabal/doc/README.md → doc/README.md b/Cabal/doc/README.md → doc/README.md
diff --git a/Cabal/doc/_templates/layout.html → doc/_templates/layout.html b/Cabal/doc/_templates/layout.html → doc/_templates/layout.html
diff --git a/Cabal/doc/bugs-and-stability.rst → doc/bugs-and-stability.rst b/Cabal/doc/bugs-and-stability.rst → doc/bugs-and-stability.rst
diff --git a/Cabal/doc/buildinfo-fields-reference.rst → doc/buildinfo-fields-reference.rst b/Cabal/doc/buildinfo-fields-reference.rst → doc/buildinfo-fields-reference.rst
diff --git a/Cabal/doc/cabal-commands.rst → doc/cabal-commands.rst b/Cabal/doc/cabal-commands.rst → doc/cabal-commands.rst
diff --git a/Cabal/doc/cabal-package.rst → doc/cabal-package.rst b/Cabal/doc/cabal-package.rst → doc/cabal-package.rst
diff --git a/Cabal/doc/cabal-project.rst → doc/cabal-project.rst b/Cabal/doc/cabal-project.rst → doc/cabal-project.rst
diff --git a/Cabal/doc/cabaldomain.py → doc/cabaldomain.py b/Cabal/doc/cabaldomain.py → doc/cabaldomain.py
diff --git a/Cabal/doc/concepts-and-development.rst → doc/concepts-and-development.rst b/Cabal/doc/concepts-and-development.rst → doc/concepts-and-development.rst
diff --git a/Cabal/doc/conf.py → doc/conf.py b/Cabal/doc/conf.py → doc/conf.py
@@ -68,13 +68,13 @@
 html_use_smartypants = True
 html_show_copyright = True
 html_context = {
-    'source_url_prefix': "https://github.com/haskell/cabal/tree/master/Cabal/doc/",
+    'source_url_prefix': "https://github.com/haskell/cabal/tree/master/doc/",
     "display_github": True,
     "github_host": "github.com",
     "github_user": "haskell",
     "github_repo": 'cabal',
     "github_version": "master/",
-    "conf_py_path": "Cabal/doc/",
+    "conf_py_path": "doc/",
     "source_suffix": '.rst',
 }
 

diff --git a/Cabal/doc/config-and-install.rst → doc/config-and-install.rst b/Cabal/doc/config-and-install.rst → doc/config-and-install.rst
diff --git a/Cabal/doc/developing-packages.rst → doc/developing-packages.rst b/Cabal/doc/developing-packages.rst → doc/developing-packages.rst
diff --git a/Cabal/doc/file-format-changelog.rst → doc/file-format-changelog.rst b/Cabal/doc/file-format-changelog.rst → doc/file-format-changelog.rst
diff --git a/Cabal/doc/getting-started.rst → doc/getting-started.rst b/Cabal/doc/getting-started.rst → doc/getting-started.rst
diff --git a/Cabal/doc/hcar/.gitignore → doc/hcar/.gitignore b/Cabal/doc/hcar/.gitignore → doc/hcar/.gitignore
diff --git a/Cabal/doc/hcar/Cabal-201604.tex → doc/hcar/Cabal-201604.tex b/Cabal/doc/hcar/Cabal-201604.tex → doc/hcar/Cabal-201604.tex
diff --git a/Cabal/doc/hcar/Cabal-201611.tex → doc/hcar/Cabal-201611.tex b/Cabal/doc/hcar/Cabal-201611.tex → doc/hcar/Cabal-201611.tex
diff --git a/Cabal/doc/hcar/Cabal-201811.tex → doc/hcar/Cabal-201811.tex b/Cabal/doc/hcar/Cabal-201811.tex → doc/hcar/Cabal-201811.tex
diff --git a/Cabal/doc/hcar/hcar.sty → doc/hcar/hcar.sty b/Cabal/doc/hcar/hcar.sty → doc/hcar/hcar.sty
diff --git a/Cabal/doc/hcar/main.tex → doc/hcar/main.tex b/Cabal/doc/hcar/main.tex → doc/hcar/main.tex
diff --git a/Cabal/doc/images/Cabal-dark.png → doc/images/Cabal-dark.png b/Cabal/doc/images/Cabal-dark.png → doc/images/Cabal-dark.png
diff --git a/Cabal/doc/index.rst → doc/index.rst b/Cabal/doc/index.rst → doc/index.rst
diff --git a/Cabal/doc/installing-packages.rst → doc/installing-packages.rst b/Cabal/doc/installing-packages.rst → doc/installing-packages.rst
diff --git a/Cabal/doc/intro.rst → doc/intro.rst b/Cabal/doc/intro.rst → doc/intro.rst
diff --git a/Cabal/doc/misc.rst → doc/misc.rst b/Cabal/doc/misc.rst → doc/misc.rst
diff --git a/Cabal/doc/nix-integration.rst → doc/nix-integration.rst b/Cabal/doc/nix-integration.rst → doc/nix-integration.rst
diff --git a/Cabal/doc/nix-local-build-overview.rst → doc/nix-local-build-overview.rst b/Cabal/doc/nix-local-build-overview.rst → doc/nix-local-build-overview.rst
diff --git a/Cabal/doc/nix-local-build.rst → doc/nix-local-build.rst b/Cabal/doc/nix-local-build.rst → doc/nix-local-build.rst
diff --git a/Cabal/doc/references.inc → doc/references.inc b/Cabal/doc/references.inc → doc/references.inc
diff --git a/Cabal/doc/requirements.txt → doc/requirements.txt b/Cabal/doc/requirements.txt → doc/requirements.txt
diff --git a/Cabal/doc/setup-commands.rst → doc/setup-commands.rst b/Cabal/doc/setup-commands.rst → doc/setup-commands.rst