diff --git a/.gitignore b/.gitignore index dca6125d8..ab9abb92f 100644 --- a/.gitignore +++ b/.gitignore @@ -21,6 +21,7 @@ ncdap_test/findtestserver.c ##### ### 'Normal' gitignore files. +nug.tag netcdf-c.tag autom4te.cache debug.txt diff --git a/docs/DAP2.dox b/NUG/DAP2.dox similarity index 100% rename from docs/DAP2.dox rename to NUG/DAP2.dox diff --git a/NUG/Doxyfile b/NUG/Doxyfile index 96aa8a085..a1adadc49 100644 --- a/NUG/Doxyfile +++ b/NUG/Doxyfile @@ -791,9 +791,10 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = guide.md \ +INPUT = guide.dox \ bestpractices.md \ install.md \ + DAP2.dox \ DAP4.dox \ OPeNDAP.dox \ types.dox \ @@ -990,7 +991,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = guide.md +USE_MDFILE_AS_MAINPAGE = guide.dox #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1232,17 +1233,6 @@ HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = NO -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via Javascript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have Javascript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. @@ -2135,13 +2125,13 @@ SKIP_FUNCTION_MACROS = YES # run, you must also specify the path to the tagfile here. #TAGFILES = ../../netcdf-c/netcdf-c.tag=../../../netcdf-c/html -TAGFILES = ../netcdf-c.tag +TAGFILES = ../netcdf-c.tag=../../build-doc/docs/html # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = nug.tag +GENERATE_TAGFILE = ../nug.tag # If the ALLEXTERNALS tag is set to YES, all external class will be listed in # the class index. If set to NO, only the inherited external classes will be diff --git a/NUG/guide.dox b/NUG/guide.dox index bce34587d..5b2576dfb 100644 --- a/NUG/guide.dox +++ b/NUG/guide.dox @@ -1,6 +1,9 @@ -/*! \page user_guide The NetCDF User's Guide +/*! \mainpage The NetCDF User's Guide -

The sections of the netCDF User's Guide

+\section user_guide The NetCDF User's Guide + + +\subsection user_guide_toc Table of Contents - \subpage netcdf_introduction - \subpage file_structure_and_performance @@ -14,7 +17,7 @@ - \subpage dap2 - \subpage dap4 -

The Purpose of NetCDF

+\section nc_purpose The Purpose of NetCDF The purpose of the Network Common Data Form (netCDF) interface is to allow you to create, access, and share array-oriented data in a form diff --git a/NUG/nug.tag b/NUG/nug.tag deleted file mode 100644 index df34b800f..000000000 --- a/NUG/nug.tag +++ /dev/null @@ -1,157 +0,0 @@ - - - - bestpractices.md - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - bestpractices_8md - - - DAP4.dox - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - _d_a_p4_8dox - - - filters.md - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - filters_8md - - - guide.md - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - guide_8md - - - install.md - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - install_8md - - - OPeNDAP.dox - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - _o_pe_n_d_a_p_8dox - - - types.dox - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - types_8dox - - - user_defined_formats.md - /home/wfisher/Desktop/gitprojects/netcdf-c/NUG/ - user__defined__formats_8md - - - nug_netcdf_introduction - An Introduction to NetCDF - nug_netcdf_introduction - nug_netcdf_interface - nug_netcdf_format - nug_select_format - nug_classic_format - nug_netcdf_64bit_offset_format - nug_netcdf_64bit_data_format - nug_netcdf_4_format - nug_architecture - nug_performance - nug_creating_self - nug_limitations - - - nug_netcdf_data_set_components - The Components of a NetCDF Data Set - nug_netcdf_data_set_components - nug_data_model - nug_Enhanced - nug_dimensions - nug_variables - nug_coordinate_variables - nug_attributes - nug_differences_atts_vars - nug_object_name - nug_Permitted - nug_Name - nug_NetCDF - nug_archival - nug_background - nug_remote_client - nug_data_access - nug_forms_of_data_access - nug_c_array_section_access - - - nug_file_structure_and_performance - File Structure and Performance - nug_file_structure_and_performance - nug_classic_file_parts - nug_parts_of_netcdf4 - nug_xdr_layer - nug_large_file_support - nug_offset_format_limitations - nug_classic_format_limitations - nug_netcdf_3_io - nug_parallel_access - nug_interoperability_with_hdf5 - - - nug_netcdf_perf_chunking - Improving Performance with Chunking - nug_netcdf_perf_chunking - nug_chunk_cache - nug_default_chunking_4_1 - nug_chunking_parallel_io - nug_bm_file - - - nug_netcdf_utilities_guide - NetCDF Utilities - nug_netcdf_utilities_guide - nug_cdl_guide - nug_cdl_syntax - nug_cdl_data_types - nug_cdl_constants - nug_ncdump_guide - nug_ncdump_SYNOPSIS - nug_ncdump_DESCRIPTION - nug_ncdump_OPTIONS - nug_ncdump_EXAMPLES - nug_see_also_ncdump - nug_ncdump_string_note - nug_guide_nccopy - nug_nccopy_SYNOPSIS - nug_nccopy_DESCRIPTION - nug_nccopy_OPTIONS - nug_nccopy_EXAMPLES - nug_see_also_nccopy - nug_guide_ncgen - nug_guide_ncgen3 - - - nug_users_guide_appendices - Appendices - nug_users_guide_appendices - - - md_filters - NetCDF-4 Filter Support - md_filters - autotoc_md3 - autotoc_md4 - autotoc_md5 - autotoc_md6 - autotoc_md7 - autotoc_md8 - autotoc_md9 - autotoc_md10 - autotoc_md11 - autotoc_md12 - autotoc_md13 - autotoc_md14 - autotoc_md15 - - - index - - index - autotoc_md0 - - diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 37f0a1cce..3bb72d8fe 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -744,18 +744,11 @@ WARN_LOGFILE = INPUT = \ @abs_top_srcdir@/docs/mainpage.dox \ @abs_top_srcdir@/RELEASE_NOTES.md \ - @abs_top_srcdir@/docs/install.md \ @abs_top_srcdir@/docs/install-fortran.md \ - @abs_top_srcdir@/docs/types.dox \ @abs_top_srcdir@/docs/windows-binaries.md \ - @abs_top_srcdir@/docs/guide.dox \ @abs_top_srcdir@/docs/attribute_conventions.md \ @abs_top_srcdir@/docs/file_format_specifications.md \ @abs_top_srcdir@/docs/byterange.dox \ - @abs_top_srcdir@/docs/DAP2.dox \ - @abs_top_srcdir@/docs/DAP4.dox \ - @abs_top_srcdir@/docs/user_defined_formats.md \ - @abs_top_srcdir@/docs/filters.md \ @abs_top_srcdir@/docs/inmemory.md \ @abs_top_srcdir@/docs/auth.md \ @abs_top_srcdir@/docs/notes.md \ @@ -764,7 +757,6 @@ INPUT = \ @abs_top_srcdir@/docs/known_problems.md \ @abs_top_srcdir@/docs/COPYRIGHT.md \ @abs_top_srcdir@/docs/credits.md \ - @abs_top_srcdir@/docs/bestpractices.md \ @abs_top_srcdir@/docs/tutorial.dox \ @abs_top_srcdir@/docs/internal.dox \ @abs_top_srcdir@/docs/inmeminternal.dox \ @@ -2065,6 +2057,7 @@ SKIP_FUNCTION_MACROS = YES # run, you must also specify the path to the tagfile here. # TAGFILES = html/guide.tag=./html_guide "html/tutorial.tag = ./html_tutorial" +TAGFILES = ../../nug.tag=../../../NUG/html # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to