Skip to content

Commit

Permalink
Fix up documentation to replace old auth documentation
Browse files Browse the repository at this point in the history
with a revised auth.md document.
  • Loading branch information
DennisHeimbigner committed Aug 21, 2017
1 parent b0cf032 commit 3783491
Show file tree
Hide file tree
Showing 6 changed files with 442 additions and 16 deletions.
2 changes: 0 additions & 2 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +0,0 @@
auth.md
auth.html
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,7 @@ INPUT = \
@abs_top_srcdir@/docs/file_format_specifications.md \
@abs_top_srcdir@/docs/tutorial.dox \
@abs_top_srcdir@/docs/notes.md \
@abs_top_srcdir@/docs/esg.md \
@abs_top_srcdir@/docs/auth.md \
@abs_top_srcdir@/docs/all-error-codes.md \
@abs_top_srcdir@/docs/FAQ.md \
@abs_top_srcdir@/docs/known_problems.md \
Expand Down
14 changes: 2 additions & 12 deletions docs/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ EXTRA_DIST = netcdf.m4 DoxygenLayout.xml Doxyfile.in footer.html \
building-with-cmake.md CMakeLists.txt \
groups.dox install.md notes.md install-fortran.md \
all-error-codes.md cmake_faq.md credits.md \
auth.html obsolete/fan_utils.html bestpractices.md
auth.md obsolete/fan_utils.html bestpractices.md

# Turn off parallel builds in this directory.
.NOTPARALLEL:
Expand Down Expand Up @@ -51,7 +51,7 @@ endif

doxyfile.stamp:
$(DOXYGEN) Doxyfile \
cp auth.html obsolete/fan_utils.html html
cp auth.md obsolete/fan_utils.html html

CLEANFILES = doxyfile.stamp html latex man

Expand All @@ -62,13 +62,3 @@ CLEANFILES = doxyfile.stamp html latex man
web-tarball: doxyfile.stamp
cd html; tar cf ../netcdf_docs.tar *
gzip -f netcdf_docs.tar

# When oc2/auth.html.in is changed, you should generate auth.html
# using the following process.
oc2-auth:
cat ${top_srcdir}/oc2/auth.html.in \
| sed -e '/<OC>/d' \
| sed -e 's|^<NC>||' \
| sed -e 's|zz|netcdf|g' -e 's|ZZ|netCDF|g' \
| sed -e '/stylesheet/r${top_srcdir}/oc2/oc.css' -e '/stylesheet/d' \
> auth.html
2 changes: 1 addition & 1 deletion docs/OPeNDAP.dox
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ DDS and DAS, refer to the OPeNDAP web site http://opendap.org.
See the following pages for more information.

- \subpage dap_accessing_data
- <a href="auth.html">netCDF Authorization Support</a>
- <a href="auth.md">netCDF Authorization Support</a>
- \subpage dap_to_netcdf
- \subpage dap2_reserved_keywords
- \subpage var_dim_trans
Expand Down
4 changes: 4 additions & 0 deletions docs/auth.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ <h2><a name="Introduction">Introduction</a></h2>
library. This includes basic password authentication as well as
certificate-based authorization.
<p>
At the moment, this document only applies to DAP2 and DAP4 access
because they are (for now) the only parts of the netCDF-C library
that uses libcurl.
<p>
With some exceptions (e.g. see the section on <a href="#REDIR">redirection</a>)
The libcurl authorization mechanisms can be accessed in two ways
<ol>
Expand Down
Loading

0 comments on commit 3783491

Please sign in to comment.