Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 55fa12a

Browse files
committed
Fixed setupbase.py and MANIFEST.in to reflect all the changes to docs. Currently,
the full tree of our rst docs are not included in the data_files. Not sure if/how we want to handle that. It was easy when we had a single file documentation, but not we have a full directory hierarchy full of rst files.
1 parent ccc2fc9 commit 55fa12a

3 files changed

Lines changed: 20 additions & 25 deletions

File tree

MANIFEST.in

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,15 @@ graft IPython/config
1313
graft IPython/testing
1414
graft IPython/tools
1515

16-
graft doc
17-
exclude doc/\#*
18-
exclude doc/*.1
19-
exclude doc/ChangeLog.*
20-
exclude doc/update_version.sh
16+
graft docs
17+
exclude docs/\#*
18+
exclude docs/man/*.1
19+
exclude docs/ChangeLog.*
2120

2221
# There seems to be no way of excluding whole subdirectories, other than
2322
# manually excluding all their subdirs. distutils really is horrible...
24-
exclude doc/attic/*
25-
exclude doc/build/doctrees/*
26-
exclude doc/build/html/_sources/*
27-
exclude doc/build/html/_static/*
28-
exclude doc/build/html/*
29-
exclude doc/build/latex/*
23+
exclude docs/attic/*
24+
exclude docs/build/*
3025

3126
global-exclude *~
3227
global-exclude *.flc

setup.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,17 +88,21 @@
8888
"cd doc && gzip -9c pycolor.1 > pycolor.1.gz"),
8989
]
9090

91+
# Only build the docs is sphinx is present
9192
try:
9293
import sphinx
9394
except ImportError:
9495
pass
9596
else:
97+
# BEG: This is disabled as I am not sure what to depend on.
98+
# I actually don't think we should be automatically building
99+
# the docs for people.
96100
# The do_sphinx scripts builds html and pdf, so just one
97101
# target is enough to cover all manual generation
98-
to_update.append(
99-
('doc/manual/ipython.pdf',
100-
['IPython/Release.py','doc/source/ipython.rst'],
101-
"cd doc && python do_sphinx.py")
102+
# to_update.append(
103+
# ('doc/manual/ipython.pdf',
104+
# ['IPython/Release.py','doc/source/ipython.rst'],
105+
# "cd docs && python do_sphinx.py")
102106
)
103107
[ target_update(*t) for t in to_update ]
104108

setupbase.py

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -148,19 +148,15 @@ def find_data_files():
148148
# We only need to exclude from this things NOT already excluded in the
149149
# MANIFEST.in file.
150150
exclude = ('.sh','.1.gz')
151-
docfiles = filter(lambda f:file_doesnt_endwith(f,exclude),glob('doc/*'))
152-
examfiles = filter(isfile, glob('doc/examples/*.py'))
153-
manfiles = filter(isfile, glob('doc/manual/*'))
154-
manstatic = filter(isfile, glob('doc/manual/_static/*'))
155-
manpages = filter(isfile, glob('doc/*.1.gz'))
156-
scriptfiles = filter(isfile, ['scripts/ipython','scripts/pycolor',
157-
'scripts/irunner'])
151+
# We need to figure out how we want to package all of our rst docs?
152+
# docfiles = filter(lambda f:file_doesnt_endwith(f,exclude),glob('docs/*'))
153+
examfiles = filter(isfile, glob('docs/examples/core/*.py'))
154+
examfiles.append(filter(isfile, glob('docs/examples/kernel/*.py')))
155+
manpages = filter(isfile, glob('docs/man/*.1.gz'))
158156
igridhelpfiles = filter(isfile, glob('IPython/Extensions/igrid_help.*'))
159157

160-
data_files = [('data', docdirbase, docfiles),
158+
data_files = [#('data', docdirbase, docfiles),
161159
('data', pjoin(docdirbase, 'examples'),examfiles),
162-
('data', pjoin(docdirbase, 'manual'),manfiles),
163-
('data', pjoin(docdirbase, 'manual/_static'),manstatic),
164160
('data', manpagebase, manpages),
165161
('data',pjoin(docdirbase, 'extensions'),igridhelpfiles),
166162
]

0 commit comments

Comments
 (0)