Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

doc: fix warnings

this fixes uncritical warnings during the manual/api compilation:

* don't quote using backticks
* mark orphan docs as such
* don't refer to non-existant static files to be copied over
  • Loading branch information...
commit c2d3ad9f539877294a031aae9ae410d0e96bf642 1 parent 1e66018
Patrick Totzke authored
2  docs/source/conf.py
View
@@ -149,7 +149,7 @@ def __getattr__(self, name):
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
8 docs/source/configuration/accounts_table.rst
View
@@ -1,5 +1,7 @@
-..
- CAUTION: THIS FILE IS AUTO-GENERATED
+
+:orphan:
+
+.. CAUTION: THIS FILE IS AUTO-GENERATED
from the inline comments of specfile defaults/alot.rc.spec.
If you want to change its content make your changes
@@ -38,7 +40,7 @@
sendmail command. This is the shell command used to send out mails via the sendmail protocol
:type: string
- :default: `sendmail -t`
+ :default: "sendmail -t"
.. _sent-box:
30 docs/source/configuration/alotrc_table.rst
View
@@ -1,5 +1,7 @@
-..
- CAUTION: THIS FILE IS AUTO-GENERATED
+
+:orphan:
+
+.. CAUTION: THIS FILE IS AUTO-GENERATED
from the inline comments of specfile defaults/alot.rc.spec.
If you want to change its content make your changes
@@ -21,7 +23,7 @@
directory prefix for downloading attachments
:type: string
- :default: `~`
+ :default: "~"
.. _authors-maxlength:
@@ -174,7 +176,7 @@
file encoding used by your editor
:type: string
- :default: `UTF-8`
+ :default: "UTF-8"
.. _envelope-headers-blacklist:
@@ -220,7 +222,7 @@
only if original subject doesn't start with 'Fwd:' or this prefix
:type: string
- :default: `Fwd: `
+ :default: "Fwd: "
.. _hooksfile:
@@ -230,7 +232,7 @@
where to look up hooks
:type: string
- :default: `~/.config/alot/hooks.py`
+ :default: "~/.config/alot/hooks.py"
.. _initial-command:
@@ -240,7 +242,7 @@
initial command when none is given as argument:
:type: string
- :default: `search tag:inbox AND NOT tag:killed`
+ :default: "search tag:inbox AND NOT tag:killed"
.. _notify-timeout:
@@ -273,7 +275,7 @@
Suffix of the prompt used when waiting for user input
:type: string
- :default: `:`
+ :default: ":"
.. _quit-on-last-bclose:
@@ -293,7 +295,7 @@
String prepended to line when quoting
:type: string
- :default: `> `
+ :default: "> "
.. _reply-subject-prefix:
@@ -304,7 +306,7 @@
only if original subject doesn't start with 'Re:' or this prefix
:type: string
- :default: `Re: `
+ :default: "Re: "
.. _search-statusbar:
@@ -375,7 +377,7 @@
It will be used if you give `compose --template` a filename without a path prefix.
:type: string
- :default: `$XDG_CONFIG_HOME/alot/templates`
+ :default: "$XDG_CONFIG_HOME/alot/templates"
.. _terminal-cmd:
@@ -385,7 +387,7 @@
set terminal command used for spawning shell commands
:type: string
- :default: `x-terminal-emulator -e`
+ :default: "x-terminal-emulator -e"
.. _theme:
@@ -416,7 +418,7 @@
:ref:`thread_authors_replace_me <thread-authors-replace-me>`
:type: string
- :default: `Me`
+ :default: "Me"
.. _thread-authors-replace-me:
@@ -467,5 +469,5 @@
The string '{version}' will be replaced by the version string of the running instance.
:type: string
- :default: `alot/{version}`
+ :default: "alot/{version}"
2  docs/source/description.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
Alot is a terminal-based mail user agent for the notmuch mail system.
It features a modular and command prompt driven interface
to provide a full MUA experience as an alternative to the Emacs mode shipped
2  docs/source/generate_commands.py
View
@@ -15,7 +15,7 @@
import sys as _sys
import textwrap as _textwrap
-NOTE = ".. CAUTION: THIS FILE IS AUTO-GENERATED!\n\n\n"
+NOTE = ":orphan:\n\n.. CAUTION: THIS FILE IS AUTO-GENERATED!\n\n\n"
class HF(HelpFormatter):
def _metavar_formatter(self, action, default_metavar):
8 docs/source/generate_configs.py
View
@@ -6,8 +6,10 @@
from configobj import ConfigObj
from validate import Validator
import re
-NOTE = """..
- CAUTION: THIS FILE IS AUTO-GENERATED
+NOTE = """
+:orphan:
+
+.. CAUTION: THIS FILE IS AUTO-GENERATED
from the inline comments of specfile %s.
If you want to change its content make your changes
@@ -49,7 +51,7 @@ def rewrite_entries(config, path, specpath, sec=None, sort=False):
if default != None:
default = default.replace('*','\\*')
if etype in ['string', 'string_list', 'gpg_key_hint'] and default != 'None':
- description += ' :default: `%s`\n\n' % (default)
+ description += ' :default: "%s"\n\n' % (default)
else:
description += ' :default: %s\n\n' % (default)
file.write(description)
2  docs/source/manpage.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
Manpage
=======
2  docs/source/usage/commands.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
Commands
========
2  docs/source/usage/first_steps.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
The arrow keys, `page-up/down`, `j`, `k` and `Space` can be used to move the focus.
`Escape` cancels prompts and `Enter` selects. Hit `:` at any time and type in commands
to the prompt.
2  docs/source/usage/modes/bufferlist.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
.. CAUTION: THIS FILE IS AUTO-GENERATED!
4 docs/source/usage/modes/envelope.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
.. CAUTION: THIS FILE IS AUTO-GENERATED!
@@ -51,7 +53,7 @@ ____
edit mail
optional arguments
- :---spawn: force spawning of editor in a new terminal.
+ :---spawn: spawn editor in new terminal.
:---refocus: refocus envelope after editing (Defaults to: 'True').
.. _cmd_envelope_send:
2  docs/source/usage/modes/global.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
.. CAUTION: THIS FILE IS AUTO-GENERATED!
2  docs/source/usage/modes/search.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
.. CAUTION: THIS FILE IS AUTO-GENERATED!
2  docs/source/usage/modes/taglist.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
.. CAUTION: THIS FILE IS AUTO-GENERATED!
2  docs/source/usage/modes/thread.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
.. CAUTION: THIS FILE IS AUTO-GENERATED!
2  docs/source/usage/synopsis.rst
View
@@ -1,3 +1,5 @@
+:orphan:
+
.. code-block:: none
alot [-r] [-c CONFIGFILE] [-n NOTMUCHCONFIGFILE] [-C {1,16,256}] [-p DB_PATH]
Please sign in to comment.
Something went wrong with that request. Please try again.