Skip to content

Commit

Permalink
Update all references to doc/sphinx, update Makefiles
Browse files Browse the repository at this point in the history
  • Loading branch information
Ben Albrecht committed Sep 29, 2016
1 parent 541c508 commit 8f92bc5
Show file tree
Hide file tree
Showing 15 changed files with 33 additions and 48 deletions.
6 changes: 3 additions & 3 deletions Makefile
Expand Up @@ -134,15 +134,15 @@ clean: FORCE
cd modules && $(MAKE) clean
cd runtime && $(MAKE) clean
cd third-party && $(MAKE) clean
-@[ -d doc/sphinx ] && cd doc/sphinx && $(MAKE) clean
cd doc && $(MAKE) clean
rm -f util/chplenv/*.pyc

cleanall: FORCE
cd compiler && $(MAKE) cleanall
cd modules && $(MAKE) cleanall
cd runtime && $(MAKE) cleanall
cd third-party && $(MAKE) cleanall
-@[ -d doc/sphinx ] && cd doc/sphinx && $(MAKE) cleanall
cd doc && $(MAKE) cleanall
rm -f util/chplenv/*.pyc

cleandeps: FORCE
Expand All @@ -155,7 +155,7 @@ clobber: FORCE
cd runtime && $(MAKE) clobber
cd third-party && $(MAKE) clobber
cd tools/chplvis && $(MAKE) clobber
-@[ -d doc/sphinx ] && cd doc/sphinx && $(MAKE) clobber
cd doc $(MAKE) clobber
rm -rf bin
rm -rf lib
rm -f util/chplenv/*.pyc
Expand Down
28 changes: 4 additions & 24 deletions Makefile.devel
Expand Up @@ -21,10 +21,10 @@ develall: STATUS
@$(MAKE) always-build-man

docs: chpldoc
cd doc/sphinx && $(MAKE) docs
cd doc && $(MAKE) docs

checkdocs: FORCE
cd doc/sphinx && $(MAKE) checkdocs
cd doc && $(MAKE) checkdocs

man: third-party-chpldoc-venv FORCE
cd man && $(MAKE)
Expand All @@ -33,9 +33,9 @@ man-chpldoc: FORCE
cd man && $(MAKE) chpldoc

man-chapel: FORCE
cd doc/sphinx && $(MAKE) man-chapel
cd doc && $(MAKE) man-chapel
mkdir -p man/man3
cp doc/sphinx/build/man/chapel.3 man/man3/chapel.3
cp doc/build/man/chapel.3 man/man3/chapel.3

always-build-man: FORCE
-@if [ -n "$$CHPL_ALWAYS_BUILD_MAN" ]; then \
Expand Down Expand Up @@ -63,23 +63,3 @@ FUTURES:

future_stats: FUTURES
./util/devel/test/future_stats STATUS.devel test/FUTURES

#
# This rule is designed to focus in on a sub-directory of
# doc/sphinx/source/ to accelerate doc build times when editing a doc
# and viewing the results in a tight loop. It works by naming a
# subdirectory under source/ that you wish to build. For example:
#
# make users-guide.docs
#
# will remake the user's guide directory. Note that a full 'make
# docs' should be performed and verified before committing any
# changes.
#
# TODO: Note that the following hard-codes the CHPL_MAKE_HOST_PLATFORM
# value in the path to sphinx-build below. Ultimately, we should
# query this, yet at present, these values are not set in this top-level
# Makefile...
#
%.docs: FORCE
third-party/chpl-venv/install/linux64/$(PYTHON_VERSION_DIR)/chpl-virtualenv/bin/sphinx-build -c doc/sphinx/source doc/sphinx/source/ doc/sphinx/build/html/$* && chmod -R ugo+rX doc/sphinx/build
10 changes: 4 additions & 6 deletions README.devel
Expand Up @@ -42,12 +42,10 @@ description:
The following files/directories in the release are based on those in
the git tree, but not exactly the same:

doc/ : for the end user, this directory is built from a
combination of the developer's doc/release directory and
some documents that are built and installed by the
gen_release script. For the developer, this directory
is currently somewhat disorganized apart from the
release/ subdirectory.
doc/ : this directory is built from a
combination of the doc/ directory and
some documents that are generated by the 'make docs' script,
when building the html documentation.

examples/ : for the end user, this directory is taken wholesale
from test/release/examples in the developer hierarchy
Expand Down
3 changes: 3 additions & 0 deletions doc/Makefile
Expand Up @@ -73,6 +73,9 @@ symlinks: clean-symlinks
checkdocs: FORCE
./util/run-in-venv.bash $(MAKE) check

%.docs: FORCE
./util/run-in-venv.bash $(MAKE) $*.html


clean: clean-source

Expand Down
4 changes: 4 additions & 0 deletions doc/Makefile.sphinx
Expand Up @@ -78,6 +78,10 @@ html-dev:
@echo
@echo "Build finished. The HTML pages are in "'$(BUILDPATH)'"/html."


%.html: FORCE
$(SPHINXBUILD) . build/html/$* && chmod -R ugo+rX build

check: check-sphinxbuild source clean-build
@echo "Checking for broken links or cross-references"
$(SPHINXBUILD) -n -b linkcheck -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/linkcheck
Expand Down
4 changes: 2 additions & 2 deletions doc/developer/bestPractices/GeneratedCode.txt
Expand Up @@ -97,7 +97,7 @@ Debugging the generated code

Using gdb and other debugging features are also discussed in:

$CHPL_HOME/doc/release/executing.rst
$CHPL_HOME/doc/usingchapel/executing.rst

* If you want to debug the runtime library as well, build your runtime so:

Expand Down Expand Up @@ -268,7 +268,7 @@ Tracing memory use
------------------

See:
$CHPL_HOME/doc/release/executing.rst
$CHPL_HOME/doc/usingchapel/executing.rst


Miscellanea
Expand Down
6 changes: 3 additions & 3 deletions doc/developer/bestPractices/buildingdocs.rst
Expand Up @@ -10,6 +10,6 @@ make target::
[g]make docs

This will build the documentation for the standard and internal modules using
chpldoc, and symlink all of the ``$CHPL_HOME/doc/release`` documents over to
a sphinx project that lives in ``$CHPL_HOME/doc/sphinx``. Once built,
the documentation can be viewed at ``$CHPL_HOME/doc/sphinx/build/html/index.html``.
chpldoc, and symlink all of the ``$CHPL_HOME/doc/`` documents over to
a sphinx project that lives in ``$CHPL_HOME/doc/``. Once built,
the documentation can be viewed at ``$CHPL_HOME/doc/build/html/index.html``.
2 changes: 1 addition & 1 deletion modules/standard/Help.chpl
Expand Up @@ -30,7 +30,7 @@
}
}
See doc/release/technotes/main.rst in a Chapel release for more
See doc/technotes/main.rst in a Chapel release for more
information on this feature.
Programs that use this feature might need to expand upon the usage message
Expand Down
2 changes: 1 addition & 1 deletion runtime/include/chpl-mem.h
Expand Up @@ -35,7 +35,7 @@

/* The names and arguments for these functions are part
of Chapel's user-facing interface because they are
documented in a README doc/release
documented in a doc/developer README
*/
// start public interface
static inline void* chpl_calloc(size_t n, size_t size);
Expand Down
2 changes: 1 addition & 1 deletion runtime/include/qio/qio_plugin_hdfs.h
Expand Up @@ -18,7 +18,7 @@
*/

// This defines the HDFS implementation/interface to the QIO filesystem plugin.
// Documentation can be found in $CHPL_HOME/doc/release/technotes/
// Documentation can be found in $CHPL_HOME/doc/technotes/
#ifndef QIOPLUGIN_HDFS_H_
#define QIOPLUGIN_HDFS_H_

Expand Down
2 changes: 1 addition & 1 deletion runtime/src/qio/auxFilesys/hdfs/qio_plugin_hdfs.c
Expand Up @@ -17,7 +17,7 @@
* limitations under the License.
*/

// Documentation can be found in $CHPL_HOME/doc/release/technotes/IO.hdfs
// Documentation can be found in $CHPL_HOME/doc/technotes/IO.hdfs
#define QIOPLUGIN_HDFS_C

#ifndef _DARWIN_C_SOURCE
Expand Down
2 changes: 1 addition & 1 deletion spec/Makefile
Expand Up @@ -17,7 +17,7 @@ usedvi:
./collect_syntax.pl # again to show errors

publish:
cp spec.pdf ../doc/release/chapelLanguageSpec.pdf
cp spec.pdf ../doc/language/chapelLanguageSpec.pdf

clean:
rm -f *.aux *.blg *.bbl *.dvi *.log
Expand Down
4 changes: 2 additions & 2 deletions test/release/examples/primers/chplvis/README
@@ -1,7 +1,7 @@
These programs, prog1.chpl through prog4.chpl, are part of the chplvis
These programs, chplvis1.chpl through chplvis4.chpl, are part of the chplvis
primer. It is best to read that primer instead of reading these file.
Use these files to try out chplvis while reading the primer.

If these programs are modified, the corresponding chplvis.rst file
must be updated to match. chplvis.rst is located in
chapel/doc/sphinx/source/tools/chplvis.
chapel/doc/tools/chplvis.
4 changes: 2 additions & 2 deletions test/release/examples/primers/chplvis/chplvis1.chpl
@@ -1,7 +1,7 @@
// chplvis: Basic Usage

// Example 1 using visual debug
// Full primer is found in doc/sphinx/source/tools/chplvis/chplvis.rst.
// Full primer is found in doc/tools/chplvis/chplvis.rst.
// Please read that documentation for a better understanding of chplvis.

// The standard module "VisualDebug" is needed to generate data
Expand All @@ -27,5 +27,5 @@ stopVdebug();
// Now that the program has completed and generated data files,
// run "chplvis E1" to look at the results.
//
// The chplvis.rst documentation in doc/sphinx/source/tools/chplvis shows you
// The chplvis.rst documentation in doc/tools/chplvis shows you
// what you should expect to see when running chplvis.
2 changes: 1 addition & 1 deletion test/release/examples/primers/chplvis/chplvis2.chpl
@@ -1,7 +1,7 @@
// chplvis: Tags

// Example 2 of use of the VisualDebug module and chplvis tool.
// Read the file doc/sphinx/source/tools/chplvis/chplvis.rst for full
// Read the file doc/tools/chplvis/chplvis.rst for full
// documentation on chplvis.

use BlockDist;
Expand Down

0 comments on commit 8f92bc5

Please sign in to comment.