Ward Fisher
628f43059f
Tweaked Header.
2015-09-23 14:42:24 -06:00
Ward Fisher
aa01e72406
More link fixes.
2015-09-23 14:38:37 -06:00
Ward Fisher
e2cc13df18
Removed some typos and fixed some dead links in documentation.
2015-09-23 14:35:33 -06:00
Ward Fisher
24e94c9d62
Rolled known problems into generated documentation, and cleaning up broken links.
2015-09-23 13:49:06 -06:00
Ward Fisher
04de80ad5d
Updated credits file to reflect information for Ward.
2015-09-22 13:15:26 -06:00
tbeu
e2820e4d8a
Fix common typos
...
Detected by https://github.com/vlajos/misspell_fixer
2015-08-20 11:42:05 +02:00
Ward Fisher
b26598c833
Merging Jen's new search option for releases into user documentation.
2015-08-17 10:59:32 -06:00
dmh
28a243b7a3
add note that parallel make cannot be used for make check
2015-07-20 16:53:34 -06:00
Russ Rew
905c35d09c
Make README.md less C-centric, add DOI citation question and answer to FAQ.
2015-07-15 09:17:15 -06:00
Ward Fisher
c7484cb4d4
Converted hand-maintained table of contents into a doxygen-generated table of contents. This will allow us to generate PDF user documentation.
2015-07-09 15:29:05 -06:00
Russ Rew
2a059523d3
Make Unidata netCDF links consistent, all using the 'software/' part of link.
2015-07-06 10:13:46 -06:00
Russ Rew
18f85ed3c3
merge origin
2015-07-06 09:53:07 -06:00
Jennifer Oxelson
eeb98c8cf9
corrected type-o
2015-07-01 11:28:44 -06:00
Jennifer Oxelson
3a93f53e83
Modified URLs paths to remove deprecated packages directory; and to link to opendap.org
2015-07-01 10:37:52 -06:00
Jennifer Oxelson
fbf232b055
Updated logo img src
2015-06-30 13:26:54 -06:00
Russ Rew
30030ce0ad
tiny update to FAQ.md
2015-06-30 10:41:05 -06:00
Russ Rew
7c0bd14178
Added commercial entry for Surfer
2015-06-15 14:38:51 -06:00
Russ Rew
157a262f08
Fix doxygen list
2015-06-08 10:20:50 -06:00
Russ Rew
406b999e2a
Fixed merge conflict
2015-06-08 10:00:03 -06:00
Russ Rew
5cca4eec35
Fix anchor in FAQ and add use of mpifzz for parallel Fortran builds to Fortran install docs
2015-06-08 09:54:33 -06:00
Ward Fisher
ca84ceb725
Updated release notes to reflect change in pre-built binary version.
2015-06-04 15:46:37 -06:00
Ward Fisher
f539c0f32e
Added reference docs for netcdf_mem work performed by Dennis. Updated Windows pre-built binary documentation to reflect the move to Visual Studio 2012, from Visual Studio 2010.
2015-06-04 15:37:52 -06:00
Ward Fisher
67c09af90e
Refactor auth to oc_auth.
2015-06-04 15:12:30 -06:00
Ward Fisher
78d0929069
Merge branch 'ward-working'. Cleaning up Doxygen warnings.
2015-06-04 15:05:56 -06:00
Ward Fisher
0f7287a470
Corrected typo.
2015-06-04 15:02:06 -06:00
Ward Fisher
bd099f65df
Removed the automatically generated TOC in the software file.
2015-06-04 15:00:05 -06:00
Ward Fisher
44c4390732
Updated generation of auth.md
2015-06-04 14:34:06 -06:00
Ward Fisher
37536f87c7
Reverted to ocauth.html. Instead of processing it automatically, we can use 'pandoc' to migrate one to the other.
2015-06-04 14:30:34 -06:00
Russ Rew
a8573500d9
Restore inadvertently overwritten updated FAQ 'How do I build and install netCDF ...'
2015-06-04 10:04:26 -06:00
Ward Fisher
497b615ed2
Corrected typo in FAQ.md
2015-06-03 15:50:43 -06:00
Ward Fisher
26a157f703
Converted ocauth.html to markdown with Pandoc.
2015-06-03 15:48:14 -06:00
Ward Fisher
76e85a9c76
Working on cleaning up the auth.md file.
2015-06-03 15:15:00 -06:00
Russ Rew
b110e1d7a5
add to FAQ our newly minted DOI to use in citing netCDF
2015-06-03 14:32:35 -06:00
Russ Rew
0e4d70319d
Distinguish between shell variables and environment variables in installation documentation. Fix FAQ reference to installation documentation.
2015-05-31 18:51:06 -06:00
Ward Fisher
1745febde0
Merge branch 'ward-working'
2015-05-26 15:39:25 -06:00
Ward Fisher
6cba2a720c
Converted html anchors into markdown-style anchors, for processing by Doxygen.
2015-05-26 11:00:35 -06:00
dmh
be5e3cd606
1. Allow for the user specified rc file via the env variable
...
DAPRCFILE. Note that the value of this environment
variable should be the absolute path of the rc file, not
the path to its containing directory.
2. fixup testauth.sh and add some new tests
3. synch oc
2015-05-24 17:31:39 -06:00
Ward Fisher
d62f382894
Cleaning up software.md file, eliminating warnings and errors generated by doxygen. Not done yet.
2015-05-22 16:03:00 -06:00
Ward Fisher
b5856bc204
Wired the new software.md file into the doxygen toolchain.
2015-05-22 15:41:38 -06:00
Ward Fisher
8610f8da90
Added 'software.md', a markdown-formatted version of the software.html page. This way it can be more easily incorporated into the documentation generated/managed by Doxygen. Conversion was handled by pandoc.
2015-05-22 15:33:44 -06:00
Ward Fisher
0f64cec6bd
Changed identifier for FAQ.md for doxygen-based documentation.
2015-05-20 10:26:13 -06:00
Russ Rew
69b2124240
More documenation tweets to improve installation instructions for netCDF-C ands netCDF-Fortran.
2015-05-01 14:39:06 -06:00
Russ Rew
5e94cd9401
Update and simplify instructions for building netcdf-fortran.
2015-04-28 13:28:56 -06:00
Russ Rew
35e5543f03
Add tweaks to install doc.
2015-04-28 11:19:31 -06:00
Russ Rew
bb08d84601
Add tweaks to install doc.
2015-04-28 11:17:47 -06:00
Ward Fisher
078013c0d1
Corrected an undefined reference warning in install.md
2015-04-23 15:42:41 -06:00
Ward Fisher
b44b687f4b
Modified auth.md to remove a bunch of warnings.
2015-04-23 15:40:19 -06:00
Russ Rew
522cf5c6ec
merge with upstream
2015-04-21 07:03:09 -06:00
Russ Rew
dbd4f6ceb4
Fix more install documentation problems.
2015-04-21 07:00:37 -06:00
dmh
8673e66640
A couple of docs/ .dox files have apparently
...
been converted to .md.
2015-04-16 16:44:51 -06:00
Ward Fisher
85a69a3fa3
More document reorganization.
2015-03-15 15:29:58 -06:00
Ward Fisher
aee5888f76
Updated doxygen pdf target.
2015-03-13 15:02:13 -06:00
Ward Fisher
ee006f4938
Updated convention documentation, added param and returns tags to comment header for nc_inq_unlimdims
2015-03-13 14:02:20 -06:00
Ward Fisher
d7d5ad1a66
Split off file format specifications into its own file (markdown extension but doxygen-style tags within, for now) and placed it as an appendix at the top level of the NetCDF User's Guide.
2015-03-13 13:28:42 -06:00
Ward Fisher
0530d65de5
Moved attribute conventions to the top level of the NetCDF User's Guide section and positioned it as an appendix, as found in the old and print documentation
2015-03-13 13:17:18 -06:00
Ward Fisher
6135610392
Deleted on redundant files.
2015-03-12 14:03:49 -06:00
Ward Fisher
b661cb2cf3
o Moved OPeNDap documentation into its own document, but retained the previous organization as part of the NetCDF User's Guide.
...
o Moved documentation around to improve the flow/organization.
o Converted the notes document to a markdown document.
2015-03-12 13:48:32 -06:00
Ward Fisher
4fa97208bd
Reorganization of user guide documentation. Moved accessing opendap data page to sit within the users guide dap-support section.
2015-03-12 12:58:57 -06:00
Ward Fisher
b6d24186d9
Formated auth.md to remove the bevy of format warnings included. Moved it to a sub-section of the NetCDF User's Guide, until a better place for it is found. It seems like we should have a DAP-related page/documentation group.
2015-03-12 11:08:23 -06:00
dmh
06a11e51df
1. Allow for the user specified rc file via the env variable
...
NCRCFILE. Note that the value of this environment
variable should be the absolute path of the rc file, not
the path to its containing directory.
2015-03-03 20:17:27 -07:00
dmh
88f1ac820c
1. synch with oc lib
...
2. update to add docs/auth.md
2015-03-02 20:26:39 -07:00
Ward Fisher
9fccf5de56
Bumped version number in preparation for the next release, 4.3.3.1
2015-02-25 10:48:12 -07:00
Ward Fisher
f3b2deafa3
Reversed non-functional pull request #100 ; the doxygen generated webpage fails to find the local image even when CMake is updated to copy the file into the same directory. Additionally, on second thought, it is also probably best to defer to the web team who want us to use the web link url.
2015-01-16 10:29:22 -07:00
Ward Fisher
80bf9a0aa2
Resolved conflict.
2015-01-16 09:28:07 -07:00
Nico Schlömer
6d2b61ddb7
hyphens used as minus signs
2015-01-16 13:12:11 +01:00
Nico Schlömer
e275b75208
Update footer.html
...
Use the local logo.
2015-01-16 10:03:43 +01:00
Ward Fisher
ee352cd622
Prepared documentation for upcoming release candidate.
2015-01-14 13:01:13 -07:00
Ward Fisher
4c239814c1
Updated links for windows binary download documentation.
2015-01-14 11:27:19 -07:00
Russ Rew
c046ca08fd
Make ncgen in guide.dox consistent with man page
2014-12-29 14:36:35 -07:00
Russ Rew
4eefcd4707
Typos and consistency fixes in docs
2014-12-29 14:22:26 -07:00
Russ Rew
40a7398b21
Added nccopy -kind_code documentation and deprecated -k format_number, need to do the same for ncgen
2014-12-13 19:50:21 -07:00
Russ Rew
4a6ec72db9
Merge branch 'master' of https://github.com/Unidata/netcdf-c into ncf-314
2014-12-11 14:19:14 -07:00
Ward Fisher
103c0b7f2e
The 'Credits' page is now a generated document distributed with netcdf, even though the contents are static. It is currently included as a subpage underneath the NetCDF Overview page. Also, renamed 'Credits' on the Overview page to 'About NetCDF'.
2014-12-10 11:14:43 -07:00
Russ Rew
e2dce0f8f2
Merge branch 'master' of https://github.com/Unidata/netcdf-c into ncf-314
2014-12-10 10:49:44 -07:00
Russ Rew
d4ba81d6ff
Documentation changes for ncdump numeric format code options
2014-12-10 10:49:37 -07:00
Ward Fisher
4c3bcbbb6f
Added a pdf version of the documentation map to aid in the doc reorg.
2014-12-09 16:38:24 -07:00
Ward Fisher
8ee89f4a08
Further reorganization. Figured out how subpage works with different files. Renamed some of the header cells.
2014-12-09 16:36:15 -07:00
Ward Fisher
790de7121e
Removed redundant error group.
2014-12-09 15:57:59 -07:00
Ward Fisher
fc3d043af1
Merged CMake FAQ into FAQ.
2014-12-09 15:31:07 -07:00
Russ Rew
eaf8ef61e0
resolved conflict
2014-12-09 13:31:20 -07:00
Russ Rew
555403170e
delete from doxygen INPUT a couple of source files lacking doxygen docs
2014-12-09 13:28:46 -07:00
Ward Fisher
a888776dd1
Reorganized tutorial document into a set of sub-pages.
2014-12-08 13:27:59 -07:00
Ward Fisher
e4f8489bc3
Reorganized Copyright file, removed some improper references.
2014-12-08 13:13:08 -07:00
Ward Fisher
25b656d276
Reordering of the tutorial and guide documents.
2014-12-08 12:20:42 -07:00
Russ Rew
027f713748
Removed deprecated -k n examples for nccopy and ncgen, fixed ncks examples
2014-12-05 15:32:38 -07:00
Ward Fisher
dca2dae3b0
Cleaned up Makefile.am
2014-12-05 15:14:40 -07:00
Ward Fisher
756a8aa7c4
Resized an image on the Windows binaries page.
2014-12-05 15:13:36 -07:00
Ward Fisher
57c9ffd877
Removed older image.
2014-12-05 15:08:03 -07:00
Ward Fisher
25033dd4f8
Updated Windows Install Tree.
2014-12-05 15:07:38 -07:00
Russ Rew
7629bd7852
Fix FILL_DOUBLE definition in classic format spec grammar
2014-12-05 12:41:37 -07:00
Ward Fisher
c437746a01
Added a section in the Windows information re: which versions of the dependencies are packaged.
2014-12-01 13:47:20 -07:00
dmh
a2e9fb854b
synch with base oc library
2014-11-21 16:20:44 -07:00
Ward Fisher
777dc3e834
Removed a number of syntax errors, dead links in the FAQ.
2014-11-21 15:18:30 -07:00
dmh
481b9ac8ee
The CDL example and the associated text
...
in docs/cdl.dox do not show and describe
how declare the type of an attribute.
So modified the example and text to
clarify. Also clarified how type inference
works for attributes whose value is a string.
2014-10-27 16:24:22 -06:00
Ward Fisher
13be04f699
Updated minimum version reference for hdf5.
2014-10-27 14:13:56 -06:00
Ward Fisher
bde6718f50
Added information re: setting the environment variables, adapted from old documentation at https://www.unidata.ucar.edu/software/netcdf/docs/netcdf-install/Environment.html#Environment . I suspect this will need to be made available for C instructions as well.
2014-10-27 12:53:59 -06:00
Ward Fisher
f595aec24a
Updated references for impending rc2 release.
2014-09-24 10:10:38 -06:00
Ward Fisher
4958670b0c
Added a new .gitignore specific to include/.
...
Added netcdf_meta.h to user documentation generated by doxygen.
2014-09-18 15:05:08 -06:00
Ward Fisher
490387577a
Cleaned out old Doxyfile templates that aren't needed yet/any longer.
...
They will eventually be recreated but not for a while. Also, modified
the install documentation to remove references to 'ed/local'.
2014-09-18 11:26:52 -06:00
Ward Fisher
33eb968864
Added a CMake option for use at release time. DOXYGEN_ENABLE_SERVER_SIDE_SEARCH turns on server side search in the doxygen documentation. This is off by default, but when on provides a much more powerful search than the default.
2014-09-03 12:52:10 -06:00
Ward Fisher
1bd58e12f1
Propegated documentation change to autotools.
2014-09-03 12:33:52 -06:00
Ward Fisher
32ec10d440
Merged tutorial, user guide back into main documentation to make it easier to reorganize the documentation has a whole. Turned on server-side search for documentation.
2014-09-03 10:21:49 -06:00
Ward Fisher
580de54543
Replaced absolute paths with relative paths for doxygen search.
2014-09-03 09:16:04 -06:00
Ward Fisher
d2281f63e9
Updated with information re: pending 4.3.3 RC.
2014-08-25 11:03:35 -06:00
Nico Schlömer
d23808bd17
remove illegal characters from docs/FAQ.md
2014-08-22 20:30:04 +02:00
Ward Fisher
8479d0733a
Migrating manually-maintained FAQ page to a dynamically generated FAQ page. Added the FAQ in markdown format to docs.
2014-07-30 14:11:48 -06:00
Ward Fisher
9eb6e58293
Updated documentation to reflect minimum cmake version of 2.8.12.
2014-07-29 14:53:12 -06:00
Ward Fisher
f42202029a
Cleaning up Doxygen warnings, reorganization of top-level documentation.
2014-07-14 16:56:42 -06:00
Ward Fisher
42fbd842a6
Fixed CDL-related doxygen section names.
2014-07-10 11:11:05 -06:00
Ward Fisher
840d80f490
More doxygen tweaks.
2014-07-09 16:45:13 -06:00
Ward Fisher
771b553126
Cleaned up some doxygen warnings.
2014-07-09 16:27:16 -06:00
Ward Fisher
f07108ec43
Changed several cmake-based messages to use WARNING instead of STATUS. Changed DOXYGEN_LATEX_OUTPUT to DOXYGEN_PDF_OUTPUT to reflect that the latex is processed into pdf as part of the build process. Flagged the ENABLE_DOXYGEN_PDF_OUTPUT option as Experimental.
2014-06-20 17:41:09 -06:00
Ward Fisher
db488b104d
Added check for pdflatex when building PDF documentation. Documented new configuration option for CMake in RELEASE_NOTES.md
2014-06-18 15:19:14 -06:00
Ward Fisher
45e41c79f9
Added infrastructure to have cmake-based builds automatically generate PDF documentation when using Doxygen.
2014-06-18 14:33:49 -06:00
Ward Fisher
7baaeecb12
A bit of whitespace cleanup, clarification of messages in CMake-based builds.
2014-06-18 13:46:22 -06:00
Ward Fisher
7f812b367e
Manual merge of pull request https://github.com/Unidata/netcdf-c/pull/64 contributed by nschloe. Assorted CMake improvements.
2014-06-11 15:51:31 -06:00
Ward Fisher
77b79328ab
Re-added documentation relating to type conversion that had dissapeared at some point in the past.
2014-06-10 13:04:19 -06:00
Ward Fisher
fc436de57d
Updated the NetCDF Library Architecture image in the documentation.
2014-06-06 10:06:12 -06:00
Ward Fisher
3ac11849af
Removed absolute paths in doxygen documentation generation. Added new doxygen templates to the autotools-based builds.
2014-05-29 14:07:45 -06:00
Ward Fisher
b65f8ee73d
Merged pull request 'make better use of GNUInstallDirs' contributed by nschloe, https://github.com/Unidata/netcdf-c/pull/57
2014-05-21 15:15:56 -06:00
Ward Fisher
05aaa4b376
Renamed man4 directory to docs.
2014-05-21 14:40:39 -06:00
