forked from cyrusimap/cyrus-imapd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Normalising line endings for docs to lf (unix), removing crlf
- Loading branch information
Nicola Nye
committed
Apr 19, 2016
1 parent
f3fab4e
commit 40e96cb
Showing
52 changed files
with
5,550 additions
and
5,548 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
*.rst eol=lf | ||
*.py eol=lf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,34 @@ | ||
.. _admin: | ||
|
||
=================== | ||
Administrator Guide | ||
=================== | ||
|
||
|
||
Cyrus IMAP | ||
========== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
imap/admin | ||
|
||
|
||
Cyrus SASL | ||
========== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
sasl/getting_started | ||
sasl/auxiliary_properties | ||
sasl/authentication_mechanisms | ||
sasl/pwcheck | ||
sasl/faq | ||
sasl/sasl_migration | ||
|
||
|
||
.. toctree:: | ||
:hidden: | ||
|
||
.. _admin: | ||
|
||
=================== | ||
Administrator Guide | ||
=================== | ||
|
||
|
||
Cyrus IMAP | ||
========== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
imap/admin | ||
|
||
|
||
Cyrus SASL | ||
========== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
sasl/getting_started | ||
sasl/auxiliary_properties | ||
sasl/authentication_mechanisms | ||
sasl/pwcheck | ||
sasl/faq | ||
sasl/sasl_migration | ||
|
||
|
||
.. toctree:: | ||
:hidden: | ||
|
||
sasl/installation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,97 +1,97 @@ | ||
# -*- coding: utf-8 -*- | ||
""" | ||
sphinxlocal.builders.manpage | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
A replacement for the manpage builder which come bundled with Sphinx. | ||
:version: 0.1 | ||
:author: Nic Bernstein <[email protected]> | ||
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. | ||
:license: BSD, see LICENSE for details. | ||
""" | ||
|
||
from os import path | ||
|
||
from six import string_types | ||
from docutils.io import FileOutput | ||
from docutils.frontend import OptionParser | ||
|
||
from sphinx import addnodes | ||
from sphinx.errors import SphinxError | ||
from sphinx.builders import Builder | ||
from sphinx.environment import NoUri | ||
from sphinx.util.nodes import inline_all_toctrees | ||
from sphinx.util.console import bold, darkgreen | ||
from sphinx.writers.manpage import ManualPageWriter | ||
from sphinx.builders.manpage import ManualPageBuilder | ||
|
||
## | ||
# Import our customized version of the stock Writer, which has the | ||
# Translater in it. | ||
from sphinxlocal.writers.manpage import CyrusManualPageWriter | ||
|
||
class CyrusManualPageBuilder(ManualPageBuilder): | ||
""" | ||
Builds groff output in manual page format. | ||
""" | ||
name = 'cyrman' | ||
format = 'man' | ||
supported_image_types = [] | ||
|
||
#settings_spec = (u'No options defined.', u'', ()) | ||
#settings_defaults = {} | ||
|
||
def init(self): | ||
if not self.config.man_pages: | ||
self.warn('no "man_pages" config value found; no manual pages ' | ||
'will be written') | ||
|
||
def write(self, *ignored): | ||
# overwritten -- use our own version of the Writer | ||
docwriter = CyrusManualPageWriter(self) | ||
docsettings = OptionParser( | ||
defaults=self.env.settings, | ||
components=(docwriter,), | ||
read_config_files=True).get_default_values() | ||
|
||
self.info(bold('writing... '), nonl=True) | ||
|
||
for info in self.config.man_pages: | ||
docname, name, description, authors, section = info | ||
if isinstance(authors, string_types): | ||
if authors: | ||
authors = [authors] | ||
else: | ||
authors = [] | ||
|
||
targetname = '%s.%s' % (name, section) | ||
self.info(darkgreen(targetname) + ' { ', nonl=True) | ||
destination = FileOutput( | ||
destination_path=path.join(self.outdir, targetname), | ||
encoding='utf-8') | ||
|
||
tree = self.env.get_doctree(docname) | ||
docnames = set() | ||
largetree = inline_all_toctrees(self, docnames, docname, tree, | ||
darkgreen, [docname]) | ||
self.info('} ', nonl=True) | ||
self.env.resolve_references(largetree, docname, self) | ||
# remove pending_xref nodes | ||
for pendingnode in largetree.traverse(addnodes.pending_xref): | ||
pendingnode.replace_self(pendingnode.children) | ||
|
||
largetree.settings = docsettings | ||
largetree.settings.title = name | ||
largetree.settings.subtitle = description | ||
largetree.settings.authors = authors | ||
largetree.settings.section = section | ||
|
||
docwriter.write(largetree, destination) | ||
self.info() | ||
|
||
def setup(app): | ||
app.add_builder(CyrusManualPageBuilder) | ||
|
||
return {'version': '0.1'} | ||
# -*- coding: utf-8 -*- | ||
""" | ||
sphinxlocal.builders.manpage | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
A replacement for the manpage builder which come bundled with Sphinx. | ||
:version: 0.1 | ||
:author: Nic Bernstein <[email protected]> | ||
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS. | ||
:license: BSD, see LICENSE for details. | ||
""" | ||
|
||
from os import path | ||
|
||
from six import string_types | ||
from docutils.io import FileOutput | ||
from docutils.frontend import OptionParser | ||
|
||
from sphinx import addnodes | ||
from sphinx.errors import SphinxError | ||
from sphinx.builders import Builder | ||
from sphinx.environment import NoUri | ||
from sphinx.util.nodes import inline_all_toctrees | ||
from sphinx.util.console import bold, darkgreen | ||
from sphinx.writers.manpage import ManualPageWriter | ||
from sphinx.builders.manpage import ManualPageBuilder | ||
|
||
## | ||
# Import our customized version of the stock Writer, which has the | ||
# Translater in it. | ||
from sphinxlocal.writers.manpage import CyrusManualPageWriter | ||
|
||
class CyrusManualPageBuilder(ManualPageBuilder): | ||
""" | ||
Builds groff output in manual page format. | ||
""" | ||
name = 'cyrman' | ||
format = 'man' | ||
supported_image_types = [] | ||
|
||
#settings_spec = (u'No options defined.', u'', ()) | ||
#settings_defaults = {} | ||
|
||
def init(self): | ||
if not self.config.man_pages: | ||
self.warn('no "man_pages" config value found; no manual pages ' | ||
'will be written') | ||
|
||
def write(self, *ignored): | ||
# overwritten -- use our own version of the Writer | ||
docwriter = CyrusManualPageWriter(self) | ||
docsettings = OptionParser( | ||
defaults=self.env.settings, | ||
components=(docwriter,), | ||
read_config_files=True).get_default_values() | ||
|
||
self.info(bold('writing... '), nonl=True) | ||
|
||
for info in self.config.man_pages: | ||
docname, name, description, authors, section = info | ||
if isinstance(authors, string_types): | ||
if authors: | ||
authors = [authors] | ||
else: | ||
authors = [] | ||
|
||
targetname = '%s.%s' % (name, section) | ||
self.info(darkgreen(targetname) + ' { ', nonl=True) | ||
destination = FileOutput( | ||
destination_path=path.join(self.outdir, targetname), | ||
encoding='utf-8') | ||
|
||
tree = self.env.get_doctree(docname) | ||
docnames = set() | ||
largetree = inline_all_toctrees(self, docnames, docname, tree, | ||
darkgreen, [docname]) | ||
self.info('} ', nonl=True) | ||
self.env.resolve_references(largetree, docname, self) | ||
# remove pending_xref nodes | ||
for pendingnode in largetree.traverse(addnodes.pending_xref): | ||
pendingnode.replace_self(pendingnode.children) | ||
|
||
largetree.settings = docsettings | ||
largetree.settings.title = name | ||
largetree.settings.subtitle = description | ||
largetree.settings.authors = authors | ||
largetree.settings.section = section | ||
|
||
docwriter.write(largetree, destination) | ||
self.info() | ||
|
||
def setup(app): | ||
app.add_builder(CyrusManualPageBuilder) | ||
|
||
return {'version': '0.1'} |
Oops, something went wrong.