summaryrefslogtreecommitdiffstats
path: root/doc/rst_source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Massive reST content renameBen Kaduk2012-10-151-280/+0
| | | | | | | | | | | All of rst_source/ is now just in doc/. The krb_ prefix is stripped from the document sub-directories. rst_tools are now just tools. The section headers of kadmind, krb5kdc, and sserver match as conflict markers. bigredbutton: whitespace ticket: 7409
* Produce man page for kadm5.aclZhanna Tsitkov2012-08-031-0/+1
|
* Support changing the built-in ccache/keytab namesGreg Hudson2012-07-241-3/+9
| | | | | | | | | | | | | | * Add DEFCCNAME, DEFKTNAME, and DEFCKTNAME configure variables to change the built-in ccache and keytab names. * Add krb5-config options to display the built-in ccache and keytab names. * In the default build, use krb5-config to discover the system's built-in ccache and keytab names and use them (if not overridden). This can be controlled with the --with-krb5-config=PATH or --without-krb5-config configure options. * Make the built-in ccache name subject to parameter expansion. ticket: 7221 (new)
* Add default_ccache_name profile variableGreg Hudson2012-07-241-0/+1
| | | | | | | Like default_keytab_name and default_client_keytab_name, default_ccache_name is subject to parameter expansion. ticket: 7220 (new)
* Standardize on commas after "e.g.", "i.e."Ben Kaduk2012-07-121-1/+1
| | | | It seems to be "more correct".
* Add krb5_kt_client_default APIGreg Hudson2012-07-021-0/+1
| | | | | | | | | | | | | | | | The default client keytab is intended to be used to automatically acquire initial credentials for client applications. The current hardcoded default is a placeholder, and will likely change before 1.11. Add test framework settings to ensure that a system default client keytab doesn't interfere with tests, and to allow tests to be written to deliberately use the default client keytab. Add documentation about keytabs to the concepts section of the RST docs, and describe the default client keytab there. ticket: 7188 (new)
* Sphinx HTML: Collapse l4 in ToC in the sidebarZhanna Tsitkov2012-06-011-1/+3
| | | | | | | Also, - resize the width of the document vs sidebar; - decrease padding in the sidebar; - mark current l2 in ToC in the sidebar.
* Modified the Sphinx HTML page layoutZhanna Tsitkov2012-05-231-1/+1
| | | | | 1. The Feedback button is moved into the footer; 2. The default page/doc width are set to 960px;
* Use "agogo" HTML theme (with some modifications) for the Sphinx ↵Zhanna Tsitkov2012-04-251-5/+5
| | | | | | documentation. Do not show the ReST source files git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25823 dc483132-0cff-0310-8789-dd5450dbe970
* Add doc target with configured path substitutionsGreg Hudson2012-03-281-0/+3
| | | | | | | | | | Add a new target "substhtml" in src/doc to create HTML documentation with configured paths, suitable for installation by an OS package. The build target generates a file named paths.py containing the directory substitutions, copies it into the rst_composite directory, and instructs conf.py to use it with the "pathsubs" tag. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25795 dc483132-0cff-0310-8789-dd5450dbe970
* Use reference substitutions for paths in docsGreg Hudson2012-03-281-15/+15
| | | | | | | | | | | | For the default doc build (used for the web site and release tarball), substitute path variables with links to the paths table in mitK5defaults.rst, using symbolic names for the link text. The substitution of kdcdir for man pages is slightly altered as a side-effect of this commit. Regenerate the man pages to match. The rendered man pages are unchanged. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25794 dc483132-0cff-0310-8789-dd5450dbe970
* Edit defaults page in documentationGreg Hudson2012-03-281-0/+3
| | | | | | | | Eliminate unused values and OS-specific stuff. Reformat tables. Add a path substitution for sysconfdir to be used in the default config file path. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25793 dc483132-0cff-0310-8789-dd5450dbe970
* Automate RST HTML generation with doxygen infoGreg Hudson2012-03-281-4/+0
| | | | | | | | | In src/doc/Makefile.in, create an "rsthtml" target for generating release tarball/web site HTML docs in doc/rst_html. For now, eliminate support for the bridge to the Doxygen HTML output; just generate XML output with Doxygen and convert it to RST format. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25791 dc483132-0cff-0310-8789-dd5450dbe970
* Remove krb5-send-pr man pageGreg Hudson2012-03-241-1/+0
| | | | | | | | | | The license on the krb5-send-pr man page was incompatible with the rest of our documentation, and the content is questionably up to date (krb5-send-pr still exists, but we don't use GNATS any more, and free-form mail to krb5-bugs is equally acceptable at this point). Get rid of it for now. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25788 dc483132-0cff-0310-8789-dd5450dbe970
* Install path-substituted man pagesGreg Hudson2012-03-231-5/+17
| | | | | | | | | | | | | | Introduce src/doc/Makefile.in, which will eventually subsume doc/Makefile (but will still pull sources from doc). In the rstman target there, create man pages with symbolic path references (like @SBINDIR@). In man/Makefile.in, substitute the path references with the configured paths before installing. Man pages generated from RST source are now checked into the source tree under the name filename.man. This lets us use a single implicit .man.sub rule for the path substitutions. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25786 dc483132-0cff-0310-8789-dd5450dbe970
* Use substitutions in RST docsGreg Hudson2012-03-221-0/+11
| | | | | | | Create an rst_epilog variable defining substitutions for pathnames and default enctypes, and use them in the RST source files. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25784 dc483132-0cff-0310-8789-dd5450dbe970
* Do not insert a timestamp into manpages and Sphinx main pageZhanna Tsitkov2012-03-191-1/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25779 dc483132-0cff-0310-8789-dd5450dbe970
* Correct the location of k5identity and k5login in the man_page section of ↵Zhanna Tsitkov2012-03-191-2/+2
| | | | | | the Sphinx config file git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25778 dc483132-0cff-0310-8789-dd5450dbe970
* Add shadow manpages for k5login.5 and k5identity.5Tom Yu2012-01-131-4/+2
| | | | | | | | | | | | Add shadow manpages dot.k5login and dot.k5identity for k5login.5 and k5identity.5. Stop generating .k5login.5 and .k5identity.5 from sphinx (these will be taken care of by make install in src/man). Add generated k5identity.5. Add SYNOPSIS sections to k5login.5 and k5identity.5 to make it more clear that the filenames start with a dot. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25653 dc483132-0cff-0310-8789-dd5450dbe970
* Added k5identity doc in RST format. Zhanna Tsitkov2012-01-121-1/+4
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25648 dc483132-0cff-0310-8789-dd5450dbe970
* Added documentation for sserver, sclient and krb5-send-pr in RST formatZhanna Tsitkov2012-01-091-0/+3
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25632 dc483132-0cff-0310-8789-dd5450dbe970
* install sphinx-generated manpagesTom Yu2012-01-091-2/+1
| | | | | | | | | | | | | | | | | Install sphinx-generated manpages. Original nroff manpages remain for reference until proofreading is complete. Modify doc/rst_source/conf.py to better deal with shadow manpages -- sphinx will now build k5login.5 instead of .k5login.5, and kadmin.1 instead of both kadmin.1 and kadmin.local.8. Proofreaders should ensure that the original nroff manpages (and associated Makefile rules) are deleted once their reST format equivalents have been proofread. ticket: 7064 status: open git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25625 dc483132-0cff-0310-8789-dd5450dbe970
* Remove MITKC logo from the treeZhanna Tsitkov2011-12-201-1/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25599 dc483132-0cff-0310-8789-dd5450dbe970
* Add ccache collection support to toolsGreg Hudson2011-09-051-0/+1
| | | | | | | | | | | | | | | | * "kdestroy -A" destroys all caches in collection. * "kinit princ" searches the collection for a matching cache and overwrites it, or creates a new cache in the collection, if the type of the default cache is collection-enabled. The chosen cache also becomes the primary cache for the collection. * "klist -l" lists (in summary form) the caches in the collection. * "klist -A" lists the content of all of the caches in the collection. * "kswitch -c cache" (new command) makes cache the primary cache. * "kswitch -p princ" makes the cache for princ the primary cache. ticket: 6956 git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25157 dc483132-0cff-0310-8789-dd5450dbe970
* Generate man pages for krb5.conf and kdc.conf. For clearer reference in the ↵Zhanna Tsitkov2011-08-161-1/+3
| | | | | | man pages, rename the x-ref label name in Supported Enc Types git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25102 dc483132-0cff-0310-8789-dd5450dbe970
* Added kdb5_ldap_util manual page to the Sphinx doc treeZhanna Tsitkov2011-08-091-0/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25078 dc483132-0cff-0310-8789-dd5450dbe970
* Added .k5login, k5srvutil, ktutil, kadmind manual documnets to Sphins doc treeZhanna Tsitkov2011-08-051-0/+4
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25073 dc483132-0cff-0310-8789-dd5450dbe970
* Added kdb5_util man page to the Sphinx doc treeZhanna Tsitkov2011-08-051-0/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25072 dc483132-0cff-0310-8789-dd5450dbe970
* Added kpropd and kproplog man pages to Sphinx doc treeZhanna Tsitkov2011-08-041-1/+3
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25071 dc483132-0cff-0310-8789-dd5450dbe970
* Added kprop document to Sphinx doc treeZhanna Tsitkov2011-08-031-0/+2
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25070 dc483132-0cff-0310-8789-dd5450dbe970
* Added kadmin_local and krb5kdc admin programs to Sphinx doc tree.Zhanna Tsitkov2011-08-031-0/+2
| | | | | | Changed the reference labels in krb5/kdc.conf files for them to appear properly in the man pages. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25069 dc483132-0cff-0310-8789-dd5450dbe970
* Added ksu and kvno man pages documentation to Sphinx doc treeZhanna Tsitkov2011-08-011-0/+2
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25066 dc483132-0cff-0310-8789-dd5450dbe970
* Option to add API documentation to the Sphinx doc treeZhanna Tsitkov2011-08-011-1/+4
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25065 dc483132-0cff-0310-8789-dd5450dbe970
* Added kpasswd, klist and kdestroy to Sphinx docs. Updated Sphinx ↵Zhanna Tsitkov2011-07-291-1/+4
| | | | | | configuration to build man pages for them git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25063 dc483132-0cff-0310-8789-dd5450dbe970
* Start building man pages from Sphinx documentation.Zhanna Tsitkov2011-07-291-2/+1
| | | | | | Added kinit document to Sphinx docs. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25062 dc483132-0cff-0310-8789-dd5450dbe970
* Removed 'viewcode' extension from the conf.py as not-required for the ↵Zhanna Tsitkov2011-06-271-1/+1
| | | | | | | | "minimal" build (i.e. build without Complete API and datatype reference section). Added README file for sphinx-build. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24992 dc483132-0cff-0310-8789-dd5450dbe970
* Initial commit of the Sphinx documentation source.Zhanna Tsitkov2011-06-231-0/+220
One can build Sphinx documentation set in the html format by calling: sphinx-build sourcedir builddir For example: sphinx-build ./rst_source /tmp/build Note: This commit does not include the "Complete Reference - API and datatypes". This results into partial disabling of the function cross-referencing enhancement in the generated documentation. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24981 dc483132-0cff-0310-8789-dd5450dbe970
generated by cgit (git 2.34.1) at 2025-10-05 23:47:54 +0000