Browse Source

update doc

master
Carl Chenet 2 years ago
parent
commit
299a66a3d1
3 changed files with 6 additions and 5 deletions
  1. +3
    -3
      docs/source/conf.py
  2. +2
    -1
      docs/source/configure.rst
  3. +1
    -1
      docs/source/install.rst

+ 3
- 3
docs/source/conf.py View File

@ -47,16 +47,16 @@ master_doc = 'index'
# General information about the project.
project = 'remindr'
copyright = '2017, Carl Chenet <chaica@ohmytux.com>'
copyright = '2017-2019, Carl Chenet <chaica@ohmytux.com>'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.2'
version = '0.3'
# The full version, including alpha/beta/rc tags.
release = '0.2'
release = '0.3'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.


+ 2
- 1
docs/source/configure.rst View File

@ -28,12 +28,14 @@ In order to configure Remindr, you need to create a remindr.ini file (or any nam
client_credentials=/etc/remindr/credentials/remindr_clientcred.txt
; Default visibility is public, but you can override it:
toot_visibility=public
; image=false
[twitter]
consumer_key=o6lv2gZxkzk6UbQ30N4vFmlwP
consumer_secret=j4VxU2slv0Ud4rbgZeGbBzPG1zoauBGLiUkOX0MGF6nsjcyn4a
access_token=1234567897-Npq5fYybhacYxnTqb42Kbb3A0bKgmB3wm2hGczB
access_token_secret=HU1snUif010DkcQ3SmUAdObAST14dZQZpuuWxGAV0xFnC
; image=false
[image]
; if you only need on image for all tweets/toots
@ -101,4 +103,3 @@ Here are the details for this example::
- The third field is the title of your message.
- The fourth field is the url to your blog post.
- The fifth and following fields could be hashtags of whatever you wish to use.

+ 1
- 1
docs/source/install.rst View File

@ -23,7 +23,7 @@ Alternatively, Setuptools may be installed to a user-local path::
* Untar the tarball and go to the source directory with the following commands::
$ tar zxvf remindr-0.2.tar.gz
$ tar zxvf remindr-0.3.tar.gz
$ cd remindr
* Next, to install Remindr on your computer, type the following command with the root user::


Loading…
Cancel
Save