felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

Use sphinx.ext.extlinks to generate frequently used links

Browse Source 
Documentation see here:
http://sphinx-doc.org/ext/extlinks.html
This commit is contained in:
Stefan Tatschner
2015-05-29 23:08:17 +02:00
parent 6ad32bfe1b
commit 385c46fd4b
4 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
conf.py
+11 -1
View File
@@ -28,7 +28,10 @@ import os
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = ['sphinx.ext.todo'] extensions = [
'sphinx.ext.todo',
'sphinx.ext.extlinks',
]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@@ -96,6 +99,13 @@ pygments_style = 'sphinx'
# Show .. todo:: block. # Show .. todo:: block.
todo_include_todos = True todo_include_todos = True
# Configure external links.
extlinks = {
'issue': ('https://github.com/syncthing/syncthing/issues/%s', 'issue #'),
'user': ('https://github.com/%s', '@'),
'commit': ('https://github.com/syncthing/syncthing/commit/%s', ''),
}
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
index.rst
+1 -1
View File
@@ -31,7 +31,7 @@ Contact
* For a more real time experience, there's also an IRC channel ``#syncthing`` on `Freenode <https://freenode.net/>`_. * For a more real time experience, there's also an IRC channel ``#syncthing`` on `Freenode <https://freenode.net/>`_.
* For other concerns you may reach out to members of the core team, currently `@calmh <https://github.com/calmh>`_, `@AudriusButkevicius <https://github.com/AudriusButkevicius>`_ and `@Zillode <https://github.com/Zillode>`_. * For other concerns you may reach out to members of the core team, currently :user:`calmh`, :user:`AudriusButkevicius` and :user:`Zillode`.
The main documentation for the site is organized into a couple of sections. You can use the heading in the left sidebar to navigate the site. The main documentation for the site is organized into a couple of sections. You can use the heading in the left sidebar to navigate the site.
users/faq.rst
+1 -3
View File
@@ -210,9 +210,7 @@ settings at default and use an ssh port forward to access it. For example,
will log you into othercomputer.example.com, and present the *remote* Syncthing will log you into othercomputer.example.com, and present the *remote* Syncthing
GUI on http://localhost:9090 on your *local* computer. You should not open more GUI on http://localhost:9090 on your *local* computer. You should not open more
than one Syncthing GUI in a single browser due to conflicting X-CSRFTokens. Any than one Syncthing GUI in a single browser due to conflicting X-CSRFTokens. Any
modification will be rejected. See `Issue 720 modification will be rejected. See :issue:`720` to work around this limitation.
<https://github.com/syncthing/syncthing/issues/720#issuecomment-58159631>`__ to
work around this limitation.
The CSRF tokens are stored using cookies. Therefore, if you get the message The CSRF tokens are stored using cookies. Therefore, if you get the message
``Syncthing seems to be experiencing a problem processing your request``, you ``Syncthing seems to be experiencing a problem processing your request``, you
users/ignoring.rst
+2 -4
View File
@@ -124,16 +124,14 @@ Assume two nodes, Alice and Bob, where Alice has 100 files to share, but
Bob ignores 25 of these. From Alice's point of view Bob will become Bob ignores 25 of these. From Alice's point of view Bob will become
about 75% in sync (the actual number depends on the sizes of the about 75% in sync (the actual number depends on the sizes of the
individual files) and remain in "Syncing" state even though it is in individual files) and remain in "Syncing" state even though it is in
fact not syncing anything (issue fact not syncing anything (:issue:`623`). From
`#623 <https://github.com/syncthing/syncthing/issues/623>`__). From
Bob's point of view it's 100% up to date but will show fewer files in Bob's point of view it's 100% up to date but will show fewer files in
both the local and global view. both the local and global view.
If Bob adds files that have already been synced to the ignore list, they If Bob adds files that have already been synced to the ignore list, they
will remain in the "global" view but disappear from the "local" view. will remain in the "global" view but disappear from the "local" view.
The end result is more files in the global repository than in the local, The end result is more files in the global repository than in the local,
but still 100% in sync (issue but still 100% in sync (:issue:`624`). From
`#624 <https://github.com/syncthing/syncthing/issues/624>`__). From
Alice's point of view, Bob will remain 100% in sync until the next Alice's point of view, Bob will remain 100% in sync until the next
reconnect, because Bob has already announce that he has the files that reconnect, because Bob has already announce that he has the files that
are now suddenly ignored. are now suddenly ignored.