Skip to content

Commit 2923a68

Browse files
committed
Moving Sphinx documentation root to the root of the repository
Sphinx is not able to include files that are outside of the directory of the root document or index. So to be able to include the Examples directory, the root of the Sphinx documentation needs to be in the root of the repository.
1 parent e79769a commit 2923a68

File tree

4 files changed

+7
-8
lines changed

4 files changed

+7
-8
lines changed

Documentation/docs/Makefile

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
SPHINXPROJ = SimpleITK
8-
SOURCEDIR = source
9-
BUILDDIR = build
8+
SOURCEDIR = ../..
9+
BUILDDIR = ../../build
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:

Documentation/docs/static/.gitignore

Whitespace-only changes.

Documentation/docs/source/conf.py conf.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
# List of patterns, relative to source directory, that match files and
7171
# directories to ignore when looking for source files.
7272
# This patterns also effect to html_static_path and html_extra_path
73-
exclude_patterns = []
73+
exclude_patterns = [".*"]
7474

7575
# The name of the Pygments (syntax highlighting) style to use.
7676
pygments_style = 'sphinx'
@@ -95,9 +95,9 @@
9595
# Add any paths that contain custom static files (such as style sheets) here,
9696
# relative to this directory. They are copied after the builtin static files,
9797
# so a file named "default.css" will overwrite the builtin "default.css".
98-
html_static_path = ['_static']
98+
html_static_path = ['Documentation/docs/static']
9999

100-
html_logo= '../../Images/simpleitk_logo.png'
100+
html_logo= 'Documentation/Images/simpleitk_logo.png'
101101

102102

103103
# -- Options for HTMLHelp output ------------------------------------------

Documentation/docs/source/index.rst index.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ and is under development.
77
.. toctree::
88
:maxdepth: 2
99

10-
faq
11-
getting_started
12-
10+
Documentation/docs/source/faq
11+
Documentation/docs/source/getting_started
1312

1413

1514
Indices and tables

0 commit comments

Comments
 (0)