Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
Spack
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
eic_tools
Spack
Commits
9de7e250
Commit
9de7e250
authored
8 years ago
by
Todd Gamblin
Browse files
Options
Downloads
Plain Diff
Merge branch 'bugfix/rtd-generation' into develop
parents
918cb169
3a9388b4
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
lib/spack/docs/.gitignore
+1
-0
1 addition, 0 deletions
lib/spack/docs/.gitignore
lib/spack/docs/Makefile
+1
-1
1 addition, 1 deletion
lib/spack/docs/Makefile
lib/spack/docs/conf.py
+16
-6
16 additions, 6 deletions
lib/spack/docs/conf.py
with
18 additions
and
7 deletions
lib/spack/docs/.gitignore
+
1
−
0
View file @
9de7e250
package_list.rst
command_index.rst
spack*.rst
modules.rst
_build
This diff is collapsed.
Click to expand it.
lib/spack/docs/Makefile
+
1
−
1
View file @
9de7e250
...
...
@@ -74,7 +74,7 @@ clean:
-
rm
-f
package_list.rst command_index.rst
-
rm
-rf
$(
BUILDDIR
)
/
*
$(
APIDOC_FILES
)
html
:
apidoc
html
:
$(
SPHINXBUILD
)
-b
html
$(
ALLSPHINXOPTS
)
$(
BUILDDIR
)
/html
@
echo
@
echo
"Build finished. The HTML pages are in
$(
BUILDDIR
)
/html."
...
...
This diff is collapsed.
Click to expand it.
lib/spack/docs/conf.py
+
16
−
6
View file @
9de7e250
...
...
@@ -42,13 +42,16 @@
import
shutil
import
subprocess
from
glob
import
glob
from
sphinx.apidoc
import
main
as
sphinx_apidoc
# -- Spack customizations -----------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
'
exts
'
))
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
'
../external
'
))
sys
.
path
.
append
(
os
.
path
.
abspath
(
'
..
/spack
'
))
sys
.
path
.
append
(
os
.
path
.
abspath
(
'
..
'
))
# Add the Spack bin directory to the path so that we can use its output in docs.
spack_root
=
'
../../..
'
...
...
@@ -60,10 +63,17 @@
[
spack_root
+
'
/bin/spack
'
,
'
-V
'
],
stderr
=
subprocess
.
PIPE
).
communicate
()[
1
].
strip
().
split
(
'
.
'
)
# Set an environment variable so that colify will print output like it would to
# a terminal.
os
.
environ
[
'
COLIFY_SIZE
'
]
=
'
25x80
'
#
# Generate package list using spack command
#
with
open
(
'
package_list.rst
'
,
'
w
'
)
as
plist_file
:
subprocess
.
check_output
(
[
spack_root
+
'
/bin/spack
'
,
'
package-list
'
])
subprocess
.
Popen
(
[
spack_root
+
'
/bin/spack
'
,
'
package-list
'
],
stdout
=
plist_file
)
...
...
@@ -81,9 +91,13 @@
shutil
.
copy
(
'
command_index.in
'
,
'
command_index.rst
'
)
with
open
(
'
command_index.rst
'
,
'
a
'
)
as
index
:
index
.
write
(
'
\n
'
)
for
cmd
in
command_names
:
for
cmd
in
sorted
(
command_names
)
:
index
.
write
(
'
* :ref:`%s`
\n
'
%
cmd
)
# Run sphinx-apidoc
sphinx_apidoc
([
'
-T
'
,
'
-o
'
,
'
.
'
,
'
../spack
'
])
#
# Exclude everything in spack.__all__ from indexing. All of these
# symbols are imported from elsewhere in spack; their inclusion in
...
...
@@ -106,10 +120,6 @@
print
line
,
# Set an environment variable so that colify will print output like it would to
# a terminal.
os
.
environ
[
'
COLIFY_SIZE
'
]
=
'
25x80
'
# Enable todo items
todo_include_todos
=
True
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment