diff --git a/Makefile b/Makefile index bc74925ca9af..4e7ce3fb6789 100644 --- a/Makefile +++ b/Makefile @@ -134,7 +134,7 @@ 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 @@ -142,7 +142,7 @@ cleanall: FORCE 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 @@ -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 diff --git a/Makefile.devel b/Makefile.devel index 020a69a0ae2d..264db9143b6c 100644 --- a/Makefile.devel +++ b/Makefile.devel @@ -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) @@ -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 \ @@ -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 diff --git a/README.devel b/README.devel index 60def5fe966a..af9210381f8e 100644 --- a/README.devel +++ b/README.devel @@ -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 diff --git a/doc/Makefile b/doc/Makefile index ed84fb47d0ca..44e9076cefad 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -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 diff --git a/doc/Makefile.sphinx b/doc/Makefile.sphinx index c7ddbff02ed8..d44227b69683 100644 --- a/doc/Makefile.sphinx +++ b/doc/Makefile.sphinx @@ -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 diff --git a/doc/developer/bestPractices/GeneratedCode.txt b/doc/developer/bestPractices/GeneratedCode.txt index 94bef6d0c3fc..e0f99d0aaf7d 100644 --- a/doc/developer/bestPractices/GeneratedCode.txt +++ b/doc/developer/bestPractices/GeneratedCode.txt @@ -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: @@ -268,7 +268,7 @@ Tracing memory use ------------------ See: - $CHPL_HOME/doc/release/executing.rst + $CHPL_HOME/doc/usingchapel/executing.rst Miscellanea diff --git a/doc/developer/bestPractices/buildingdocs.rst b/doc/developer/bestPractices/buildingdocs.rst index 3cb16250ce6e..ca037a2d09ea 100644 --- a/doc/developer/bestPractices/buildingdocs.rst +++ b/doc/developer/bestPractices/buildingdocs.rst @@ -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``. diff --git a/modules/standard/Help.chpl b/modules/standard/Help.chpl index ffdf24940d54..67c6ffac3393 100644 --- a/modules/standard/Help.chpl +++ b/modules/standard/Help.chpl @@ -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 diff --git a/runtime/include/chpl-mem.h b/runtime/include/chpl-mem.h index bb8b6f9159e3..ae5a1f78f98c 100644 --- a/runtime/include/chpl-mem.h +++ b/runtime/include/chpl-mem.h @@ -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); diff --git a/runtime/include/qio/qio_plugin_hdfs.h b/runtime/include/qio/qio_plugin_hdfs.h index 7ba0a6b2c392..4eaaf2078a75 100644 --- a/runtime/include/qio/qio_plugin_hdfs.h +++ b/runtime/include/qio/qio_plugin_hdfs.h @@ -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_ diff --git a/runtime/src/qio/auxFilesys/hdfs/qio_plugin_hdfs.c b/runtime/src/qio/auxFilesys/hdfs/qio_plugin_hdfs.c index 6b79d3cfe93a..c624e8d872d2 100644 --- a/runtime/src/qio/auxFilesys/hdfs/qio_plugin_hdfs.c +++ b/runtime/src/qio/auxFilesys/hdfs/qio_plugin_hdfs.c @@ -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 diff --git a/spec/Makefile b/spec/Makefile index bd2eeca26553..45e4a49b0bed 100644 --- a/spec/Makefile +++ b/spec/Makefile @@ -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 diff --git a/test/release/examples/primers/chplvis/README b/test/release/examples/primers/chplvis/README index 2a46c9e49c64..e9df7da5b4de 100644 --- a/test/release/examples/primers/chplvis/README +++ b/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. diff --git a/test/release/examples/primers/chplvis/chplvis1.chpl b/test/release/examples/primers/chplvis/chplvis1.chpl index bbe938ae4f80..a957153b6090 100644 --- a/test/release/examples/primers/chplvis/chplvis1.chpl +++ b/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 @@ -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. diff --git a/test/release/examples/primers/chplvis/chplvis2.chpl b/test/release/examples/primers/chplvis/chplvis2.chpl index 2ed4093b8964..cb94578be821 100644 --- a/test/release/examples/primers/chplvis/chplvis2.chpl +++ b/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;