Merge pull request #1071 from gboeing/docs

move docs source files into a source subfolder
gboeing · Oct 16, 2023 · ecfee9f · ecfee9f
2 parents c833332 + 0b59406
commit ecfee9f
Show file tree

Hide file tree

Showing 14 changed files with 17 additions and 17 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -52,7 +52,7 @@ jobs:
       - name: Test docs
         run: |
           make -C ./docs html
-          python -m sphinx -b linkcheck docs/ _build/linkcheck
+          python -m sphinx -b linkcheck docs/source build/linkcheck
 
       - name: Test code
         run: pytest --cov=./osmnx --cov-report=xml --cov-report=term-missing --verbose

diff --git a/.github/workflows/test-minimal.yml b/.github/workflows/test-minimal.yml
@@ -47,7 +47,7 @@ jobs:
       - name: Test docs
         run: |
           make -C ./docs html
-          python -m sphinx -b linkcheck docs/ _build/linkcheck
+          python -m sphinx -b linkcheck docs/source build/linkcheck
 
       - name: Test code
         run: pytest --cov=./osmnx --cov-report=term-missing --verbose
diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml
@@ -12,5 +12,5 @@ python:
     - requirements: docs/requirements.txt
 
 sphinx:
-  configuration: docs/conf.py
+  configuration: docs/source/conf.py
   fail_on_warning: true
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/make.bat b/docs/make.bat
@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
-set BUILDDIR=_build
+set SOURCEDIR=source
+set BUILDDIR=build
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
 furo
-sphinx == 7.*  # same value as needs_sphinx in /docs/conf.py
+sphinx == 7.*  # same value as needs_sphinx in /docs/source/conf.py
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -10,15 +10,15 @@
 import sys
 from pathlib import Path
 
-# go up one level from /docs/ to the package root
-sys.path.insert(0, str(Path().resolve().parent))
+# go up two levels from /docs/source to the package root
+sys.path.insert(0, str(Path().resolve().parent.parent))
 
 author = "Geoff Boeing"
 copyright = "2016-2023, Geoff Boeing"  # noqa: A001
 project = "OSMnx"
 
 # dynamically load version from /osmnx/_version.py
-with Path.open(Path("../osmnx/_version.py")) as f:
+with Path.open(Path("../../osmnx/_version.py")) as f:
     version = release = f.read().split(" = ")[1].replace('"', "")
 
 # mock import all required + optional dependency packages because readthedocs

diff --git a/docs/further-reading.rst → docs/source/further-reading.rst b/docs/further-reading.rst → docs/source/further-reading.rst
diff --git a/docs/getting-started.rst → docs/source/getting-started.rst b/docs/getting-started.rst → docs/source/getting-started.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
diff --git a/docs/installation.rst → docs/source/installation.rst b/docs/installation.rst → docs/source/installation.rst
diff --git a/docs/internals-reference.rst → docs/source/internals-reference.rst b/docs/internals-reference.rst → docs/source/internals-reference.rst
diff --git a/docs/user-reference.rst → docs/source/user-reference.rst b/docs/user-reference.rst → docs/source/user-reference.rst
diff --git a/tests/lint_test.sh b/tests/lint_test.sh
@@ -4,25 +4,25 @@
 set -e
 
 # delete temp files and folders
-rm -r -f .pytest_cache .temp ./dist/ ./docs/_build osmnx/__pycache__ tests/__pycache__
+rm -r -f .pytest_cache .temp ./dist/ ./docs/build osmnx/__pycache__ tests/__pycache__
 find . -type f -name "*.vrt" -delete
 find . -type f -name ".coverage*" -delete
 
 # lint
 pre-commit run --all-files
 
 # test building and validating the package
-#hatch build --clean
-#twine check --strict ./dist/*
+hatch build --clean
+twine check --strict ./dist/*
 
 # build the docs
-# make -C ./docs html
-# python -m sphinx -b linkcheck docs/ docs/_build/linkcheck
+make -C ./docs html
+python -m sphinx -b linkcheck docs/source docs/build/linkcheck
 
 # run the tests and report the test coverage
 pytest --cov=./osmnx --cov-report=term-missing --verbose
 
 # delete temp files and folders
-rm -r -f .pytest_cache .temp ./dist/ ./docs/_build osmnx/__pycache__ tests/__pycache__
+rm -r -f .pytest_cache .temp ./dist/ ./docs/build osmnx/__pycache__ tests/__pycache__
 find . -type f -name "*.vrt" -delete
 find . -type f -name ".coverage*" -delete