├── MANIFEST.in ├── setup.cfg ├── .gitignore ├── simplegist ├── __init__.py ├── config.py ├── simplegist.py ├── do.py ├── comments.py └── mygist.py ├── setup.py ├── LICENSE.txt ├── docs ├── create.rst ├── actions.rst ├── index.rst ├── searching.rst ├── comments.rst ├── manage.rst ├── Makefile ├── make.bat └── conf.py └── README.rst /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.rst -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # setup.py output 2 | build/ 3 | dist/ 4 | simplegist.egg-info/ 5 | *.egg-info/ 6 | 7 | # OS Files 8 | .DS_Store 9 | .DS_Store? 10 | *.pyc 11 | *~ 12 | 13 | docs/_build 14 | docs/_static 15 | docs/_templates 16 | 17 | #pypi settings file 18 | .pyirc -------------------------------------------------------------------------------- /simplegist/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | GistApi-Wrapper-python -- A python wrapper for GitHub's Gist API 3 | with advanced support to easily copy-paste the url, script,clone link 4 | without manually looking for it on GitHub 5 | (c) 2013 Varun Malhotra. MIT License 6 | """ 7 | 8 | from simplegist import * 9 | 10 | __author__ = 'Varun Malhotra' 11 | __version__ = '1.0.1' 12 | __license__ = 'MIT' -------------------------------------------------------------------------------- /simplegist/config.py: -------------------------------------------------------------------------------- 1 | ''' 2 | Either configure here or use command line arguments 3 | -U/--username for username eg. -U 'softvar' or --username 'softvar' 4 | _p/--password for password eg. -P 'secret_password' or --password 'secret_password' 5 | ''' 6 | # Your Github username 7 | USERNAME = '' 8 | 9 | # Your Github API TOKEN 10 | API_TOKEN = '' 11 | # By default setting Limit to fetch no of gists of authenticated user 12 | # or use -L/--limit as command-line arguments 13 | # Github API will always return <= 30 recent gists. 14 | LIMIT = None 15 | 16 | BASE_URL = 'https://api.github.com' 17 | GIST_URL = 'https://gist.github.com' -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | 2 | import sys 3 | from setuptools import setup 4 | 5 | required = ['requests'] 6 | 7 | 8 | if sys.version_info[:2] < (2,6): 9 | required.append('simplejson') 10 | 11 | setup( 12 | name = 'simplegist', 13 | packages = ['simplegist'], 14 | version = '1.0.1', 15 | install_requires=required, 16 | description = 'Python wrapper for Gist ', 17 | long_description=open('README.rst').read(), 18 | author = 'Varun Malhotra', 19 | author_email = 'varun2902@gmail.com', 20 | url = 'https://github.com/softvar/simplegist', 21 | download_url = 'https://github.com/softvar/simplegist/tarball/1.0.1', 22 | keywords = ['gist', 'github', 'API'], 23 | license = 'MIT', 24 | classifiers = ( 25 | "Programming Language :: Python", 26 | "Programming Language :: Python :: 2.5", 27 | "Programming Language :: Python :: 2.6", 28 | "Programming Language :: Python :: 2.7", 29 | ), 30 | ) -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Copyright (c) 2013 Varun Malhotra 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in 11 | all copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 19 | THE SOFTWARE. -------------------------------------------------------------------------------- /docs/create.rst: -------------------------------------------------------------------------------- 1 | Creating a gist 2 | =============== 3 | 4 | .. warning:: 5 | 6 | user must be authenticated 7 | 8 | .. note:: 9 | 10 | Input 11 | 12 | ``name`` 13 | *Optional* argument (*default auto-gistID*) 14 | ``description`` 15 | *Optional* argument (*default empty*) 16 | ``public`` 17 | *Optional* argument (*default public*) 18 | ``content`` 19 | *Required* argument 20 | 21 | 22 | Creating a Gist with all arguments ``create(params)`` 23 | ----------------------------------------------------- 24 | 25 | Create a new Gist simply by providing the parameters as specified above. 26 | 27 | .. code-block:: python 28 | 29 | # create a secret gist(public=0) 30 | GHgist.create(name='_GISTNAME', description='_ANY_DESCRIPTION', public=0, content='_CONTENT_GOES_HERE') 31 | 32 | Creating a Gist with *required* argument only ``create(params)`` 33 | ---------------------------------------------------------------- 34 | 35 | .. code-block:: python 36 | 37 | # create a gist with defaut name(gist:gistID, provided by github) 38 | GHgist.create(content='_CONTENT_GOES_HERE') 39 | 40 | Other Docs 41 | ^^^^^^^^^^ 42 | 43 | * :doc:`index` 44 | * :doc:`manage` 45 | * :doc:`actions` 46 | * :doc:`searching` 47 | * :doc:`comments` 48 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Github-Gist Api - python wrapper 2 | ================================ 3 | 4 | Python wrapper for ``GitHub's Gist API``. 5 | 6 | |Latest Version| |Downloads| 7 | 8 | .. |Latest Version| image:: https://img.shields.io/pypi/v/simplegist.svg 9 | :target: https://pypi.python.org/pypi/simplegist 10 | 11 | .. |Downloads| image:: https://img.shields.io/pypi/dm/simplegist.svg 12 | :target: https://pypi.python.org/pypi/simplegist 13 | 14 | Features 15 | -------- 16 | 17 | * Create Gists and get url, script and clone link on success (can be used for copy-paste purpose too) 18 | * View one's Gist(s) - name, description and it's content 19 | * Edit and Delete a gist 20 | * Search Gist(s) of any user; fork, star and unstar them 21 | * List all comments on any Gist, put/edit/delete a comment on a Gist 22 | 23 | Installation 24 | ------------- 25 | .. code-block:: bash 26 | 27 | $ pip install simplegist 28 | 29 | Download `here `_ and run ``python setup.py install`` after changing directory to ``/simplegist`` 30 | 31 | Generating Github API Access Token 32 | ---------------------------------- 33 | Go to Github's Account settings > Applications 34 | ``Create a new token`` and use it for making API requests instead of password 35 | 36 | Example Usage 37 | ------------- 38 | 39 | .. code-block:: python 40 | 41 | from simplegist import Simplegist 42 | 43 | ghGist = Simplegist(username='USERNAME', api_token='API_TOKEN') 44 | # or provide USERNAME and API_TOKEN in config.py file, so just, ghGist = Gist() 45 | 46 | # creating gist and getting url, script and clone link 47 | ghGist.create(name='_GISTNAME', description='_ANY_DESCRIPTION', public=1, content='_CONTENT_GOES_HERE') 48 | 49 | # List down all the names of authenticated user's Gists 50 | ghGist.profile().listall() 51 | 52 | # List down only the names of recent two Gists of user '_USERNAME' 53 | ghGist.search('_USERNAME').list(2) 54 | 55 | # List down all the comments on gist named '_GISTNAME' of user 'USERNAME' 56 | ghGist.comments().listall(user='_USERNAME', name='_GISTNAME') 57 | 58 | # ...and many more... 59 | 60 | Full Usage and Documentation 61 | ---------------------------- 62 | 63 | Visit here `READTHEDOCS `_ or `PYTHONHOSTED `_ 64 | 65 | Patches and suggestions are welcome 66 | ----------------------------------- 67 | 68 | .. code-block:: bash 69 | 70 | $ git clone https://github.com/softvar/simplegist.git 71 | $ cd simplegist 72 | -------------------------------------------------------------------------------- /docs/actions.rst: -------------------------------------------------------------------------------- 1 | Actions on gists 2 | ================ 3 | 4 | .. warning:: 5 | 6 | user must be authenticated 7 | 8 | Useful Information for below mentioned methods 9 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 10 | 11 | Since all the below mentioned methods require GistName/GistID. GistName is provided only when calling methods for your own Gists. Whereas GistID can be provided for all. 12 | 13 | **GistID of other users' Gist can be easily extracted without opening browser. Refer to the** 14 | :doc:`searching` **section** 15 | 16 | Check a Gist for a star ``do().checkifstar(params)`` 17 | ---------------------------------------------------- 18 | 19 | Check any Gist for a star by providing Gistname(if that Gist belongs to you) or GistID. 20 | 21 | 22 | .. note:: 23 | 24 | Input 25 | 26 | ``name/id`` 27 | provide **name** only if that gist belongs to you 28 | , provide **id** for checking correspondong Gist 29 | 30 | *Required* 31 | 32 | .. code-block:: python 33 | 34 | GHgist.do().checkifstar(id='_GISTID') 35 | 36 | # provide your Gistname 37 | GHgist.do().checkifstar(name='_YOUR_GISTNAME') 38 | 39 | Star a Gist ``do().star(params)`` 40 | --------------------------------- 41 | 42 | Star any Gist by providing Gistname(if that Gist belongs to you) or GistID. 43 | 44 | 45 | .. note:: 46 | 47 | Input 48 | 49 | ``name/id`` 50 | provide **name** only if that gist belongs to you 51 | , provide **id** for starring corresponding Gist 52 | 53 | *Required* 54 | 55 | .. code-block:: python 56 | 57 | GHgist.do().star(id='_GISTID') 58 | 59 | # provide your Gistname 60 | GHgist.do().star(name='_YOUR_GISTNAME') 61 | 62 | Unstar a Gist ``do().unstar(params)`` 63 | ------------------------------------- 64 | 65 | UnStar any Gist by providing Gistname(if that Gist belongs to you) or GistID. 66 | 67 | 68 | .. note:: 69 | 70 | Input 71 | 72 | ``name/id`` 73 | 74 | provide **name** only if that gist belongs to you 75 | , provide **id** for unstarring corresponding Gist 76 | 77 | *Required* 78 | 79 | .. code-block:: python 80 | 81 | GHgist.do().unstar(id='_GISTID') 82 | 83 | # provide your Gistname 84 | GHgist.do().unstar(name='_YOUR_GISTNAME') 85 | 86 | Fork a Gist ``do().fork(params)`` 87 | --------------------------------- 88 | 89 | Fork other's Gist by providing GistID. 90 | 91 | 92 | .. note:: 93 | 94 | Input 95 | 96 | ``id`` 97 | provide **id** for forking corresponding Gist 98 | 99 | *Required* 100 | 101 | .. code-block:: python 102 | 103 | GHgist.do().fork(id='_GISTID') 104 | 105 | Other Docs 106 | ^^^^^^^^^^ 107 | 108 | * :doc:`index` 109 | * :doc:`create` 110 | * :doc:`manage` 111 | * :doc:`searching` 112 | * :doc:`comments` -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. simplegist documentation master file, created by 2 | sphinx-quickstart on Mon Jul 15 12:56:40 2013. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to simplegist's documentation! 7 | ====================================== 8 | Helps in carrying out easy workflow for maintaining gists 9 | 10 | Features 11 | -------- 12 | 13 | * Creating gists returning the url, script and clone link for copy-paste purpose 14 | * Checkout one's gists - Name(s), Description and Content 15 | * Edit and Delete a gist 16 | * Search GitHub user's gist - fork, star and unstar them 17 | * List comments of any gist, make/edit a comment on a gist, delete a comment 18 | 19 | Installation 20 | ------------ 21 | .. code-block:: bash 22 | 23 | $ pip install simplegist 24 | 25 | Or download it from `here `_ and then, 26 | 27 | .. code-block:: bash 28 | 29 | $ cd /to/this/directory/ 30 | $ python install setup.py 31 | 32 | Generating Github API Access Token 33 | ---------------------------------- 34 | 35 | Go to Github's Account settings > Applications 36 | ``Create a new token`` and use it for making API requests instead of password. 37 | 38 | Creating an Instance 39 | --------------------- 40 | 41 | .. code-block:: python 42 | 43 | # if USERNAME and API_TOKEN are not provided in config.py 44 | GHgist = Simplegist(username='USERNAME',api_token='API_TOKEN') 45 | 46 | # else 47 | GHgist = Simplegist() 48 | 49 | Example Usage 50 | ------------- 51 | Below is an example to getting started with using GistAPI and its useful functionalities. 52 | 53 | 54 | .. code-block:: python 55 | 56 | from simplegist import SimpleGist 57 | 58 | # provide USERNAME and API_TOKEN in config.py file, so just, GHgist = Gist(), OR, 59 | GHgist = Simplegist(username='USERNAME',api_token='API_TOKEN') 60 | 61 | # creating gist and returning url, script, clone link 62 | GHgist.create(name='_GISTNAME', description='_ANY_DESCRIPTION', public=1, content='_CONTENT_GOES_HERE') 63 | 64 | # Lists all the names of authenticated user's gists 65 | GHgist.profile().listall() 66 | 67 | # Lists only the names of recent two gists of user '_USERNAME' 68 | GHgist.search('_USERNAME').list(2) 69 | 70 | # Lists all the comments on gist named '_GISTNAME' of user '_USERNAME' 71 | GHgist.comments().listall(user='_USERNAME',name='_GISTNAME') 72 | 73 | # ...and many more... 74 | 75 | Contents: 76 | --------- 77 | 78 | .. toctree:: 79 | :maxdepth: 2 80 | 81 | create 82 | manage 83 | actions 84 | searching 85 | comments 86 | 87 | Related Docs 88 | ============ 89 | 90 | * :doc:`create` 91 | * :doc:`manage` 92 | * :doc:`actions` 93 | * :doc:`searching` 94 | * :doc:`comments` 95 | -------------------------------------------------------------------------------- /docs/searching.rst: -------------------------------------------------------------------------------- 1 | Search User's gists 2 | =================== 3 | 4 | Listing all the Gists ``search('_USERNAME').listall()`` 5 | ------------------------------------------------------- 6 | 7 | Fetch all the GistsNames of a Github User. 8 | 9 | .. note:: 10 | 11 | Only recent 30 gists will be shown as per the Github API v3 12 | 13 | .. code-block:: python 14 | 15 | GHgist.search('_USERNAME').listall() 16 | 17 | Listing the required number of Gists ``search('_USERNAME').list(integer)`` 18 | -------------------------------------------------------------------------- 19 | 20 | Fetch only the limited number of Gists. 21 | 22 | .. note:: 23 | 24 | Input 25 | 26 | integer 27 | ``integer`` is **required** as an argument which will limit the number of Gists to be listed. 28 | 29 | .. code-block:: python 30 | 31 | GHgist.search('_USERNAME').list(2) 32 | 33 | Fetching the contents of a Gist using GistName ``search('_USERNAME').content(params)`` 34 | -------------------------------------------------------------------------------------- 35 | 36 | Fetch the contents of a Gist by name (GistName). 37 | 38 | .. code-block:: python 39 | 40 | GHgist.search('_USERNAME').content(name='_GISTNAME') 41 | 42 | Fetching the contents of any Gist using GistID ``search('').content(id='_GISTID')`` 43 | ----------------------------------------------------------------------------------- 44 | 45 | Fetch by id (GistID) 46 | 47 | .. code-block:: python 48 | 49 | GHgist.search('').content(id='_GISTID') 50 | 51 | Fetch GistName ``search('').getgist(id='_GISTID')`` 52 | --------------------------------------------------- 53 | 54 | Fetch Gist's name by provoding it's ID i.e. GistID. 55 | 56 | .. code-block:: python 57 | 58 | GHgist.search('').getgist(id='_GISTID') 59 | 60 | Fetch Gist-Link, Clone-Link and Embed-Script-Link of searched gist ``search('_USERNAME/EMPTY').links(id/name)`` 61 | ------------------------------------------------------------------------------------------------------------------------------ 62 | 63 | It is very very useful and solves the dual purpose. Providing the username and a Gistname of that user not only provides the above mentioned Links but also let 'one' know about the GistID of that Gist. 64 | 65 | Moreover, this criteria can also be applied in finding 'one\'s' own Gist's GistID by providing Gistname. 66 | 67 | .. note:: 68 | 69 | Input 70 | 71 | ``name/id`` - 72 | if providing GistdID, Github-Username should be blank like search(''),links(id='_GISTID') 73 | if providing GistName, Github-Username is required like search('Github-User').links(name='THATUSERSGISTNAME') 74 | 75 | *Required* 76 | 77 | .. code-block:: python 78 | 79 | GHgist.search('').links(id='_GISTID') 80 | GHgist.search('_USERNAME').links(name='_GISTNAME') 81 | 82 | Other Docs 83 | ^^^^^^^^^^ 84 | 85 | * :doc:`index` 86 | * :doc:`create` 87 | * :doc:`manage` 88 | * :doc:`actions` 89 | * :doc:`comments` 90 | -------------------------------------------------------------------------------- /simplegist/simplegist.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import json 3 | 4 | from config import USERNAME, API_TOKEN, BASE_URL, GIST_URL 5 | 6 | from mygist import Mygist 7 | from do import Do 8 | from comments import Comments 9 | 10 | class Simplegist: 11 | """ 12 | Gist Base Class 13 | 14 | This class is to used to instantiate the wrapper and authenticate. 15 | 16 | Authenticate with providing Github Username and API-Token to use 17 | it for all future API requests 18 | """ 19 | 20 | def __init__(self, **args): 21 | # Save our username and api_token (If given) for later use. 22 | if 'username' in args: 23 | self.username = args['username'] 24 | else: 25 | if not USERNAME: 26 | raise Exception('Please provide your Github username.') 27 | else: 28 | self.username = USERNAME 29 | 30 | if 'api_token' in args: 31 | self.api_token = args['api_token'] 32 | else: 33 | if not API_TOKEN: 34 | raise Exception('Please provide your Github API Token.') 35 | else: 36 | self.api_token = API_TOKEN 37 | 38 | 39 | # Set header information in every request. 40 | self.header = { 'X-Github-Username': self.username, 41 | 'Content-Type': 'application/json', 42 | 'Authorization': 'token %s' %self.api_token 43 | } 44 | 45 | def profile(self): 46 | return Mygist(self) 47 | 48 | def search(self, user): 49 | return Mygist(self,user=user) 50 | 51 | def do(self): 52 | return Do(self) 53 | 54 | def comments(self): 55 | return Comments(self) 56 | 57 | def create(self, **args): 58 | if 'description' in args: 59 | self.description = args['description'] 60 | else: 61 | self.description = '' 62 | 63 | if 'name' in args: 64 | self.gist_name = args['name'] 65 | else: 66 | self.gist_name = '' 67 | 68 | if 'public' in args: 69 | self.public = args['public'] 70 | else: 71 | self.public = 1 72 | 73 | if 'content' in args: 74 | self.content = args['content'] 75 | else: 76 | raise Exception('Gist content can\'t be empty') 77 | 78 | url = '/gists' 79 | 80 | data = {"description": self.description, 81 | "public": self.public, 82 | "files": { 83 | self.gist_name: { 84 | "content": self.content 85 | } 86 | } 87 | } 88 | 89 | r = requests.post( 90 | '%s%s' % (BASE_URL, url), 91 | data=json.dumps(data), 92 | headers=self.header 93 | ) 94 | if (r.status_code == 201): 95 | response = { 96 | 'Gist-Link': '%s/%s/%s' %(GIST_URL,self.username,r.json()['id']), 97 | 'Clone-Link': '%s/%s.git' %(GIST_URL,r.json()['id']), 98 | 'Embed-Script': '' %(GIST_URL,self.gist.username,r.json()['id']) 272 | } 273 | return content 274 | 275 | raise Exception('No such gist found') -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # simplegist documentation build configuration file, created by 4 | # sphinx-quickstart on Mon Jul 15 12:56:40 2013. 5 | # 6 | # This file is execfile()d with the current directory set to its containing dir. 7 | # 8 | # Note that not all possible configuration values are present in this 9 | # autogenerated file. 10 | # 11 | # All configuration values have a default; values that are commented out 12 | # serve to show the default. 13 | 14 | import sys, os 15 | 16 | # If extensions (or modules to document with autodoc) are in another directory, 17 | # add these directories to sys.path here. If the directory is relative to the 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. 19 | #sys.path.insert(0, os.path.abspath('.')) 20 | 21 | # -- General configuration ----------------------------------------------------- 22 | 23 | # If your documentation needs a minimal Sphinx version, state it here. 24 | #needs_sphinx = '1.0' 25 | 26 | # Add any Sphinx extension module names here, as strings. They can be extensions 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28 | extensions = [] 29 | 30 | # Add any paths that contain templates here, relative to this directory. 31 | templates_path = ['_templates'] 32 | 33 | # The suffix of source filenames. 34 | source_suffix = '.rst' 35 | 36 | # The encoding of source files. 37 | #source_encoding = 'utf-8-sig' 38 | 39 | # The master toctree document. 40 | master_doc = 'index' 41 | 42 | # General information about the project. 43 | project = u'simplegist' 44 | copyright = u'2013, Varun Malhotra' 45 | 46 | # The version info for the project you're documenting, acts as replacement for 47 | # |version| and |release|, also used in various other places throughout the 48 | # built documents. 49 | # 50 | # The short X.Y version. 51 | version = '0.3' 52 | # The full version, including alpha/beta/rc tags. 53 | release = '0.3' 54 | 55 | # The language for content autogenerated by Sphinx. Refer to documentation 56 | # for a list of supported languages. 57 | #language = None 58 | 59 | # There are two options for replacing |today|: either, you set today to some 60 | # non-false value, then it is used: 61 | #today = '' 62 | # Else, today_fmt is used as the format for a strftime call. 63 | #today_fmt = '%B %d, %Y' 64 | 65 | # List of patterns, relative to source directory, that match files and 66 | # directories to ignore when looking for source files. 67 | exclude_patterns = ['_build'] 68 | 69 | # The reST default role (used for this markup: `text`) to use for all documents. 70 | #default_role = None 71 | 72 | # If true, '()' will be appended to :func: etc. cross-reference text. 73 | #add_function_parentheses = True 74 | 75 | # If true, the current module name will be prepended to all description 76 | # unit titles (such as .. function::). 77 | #add_module_names = True 78 | 79 | # If true, sectionauthor and moduleauthor directives will be shown in the 80 | # output. They are ignored by default. 81 | #show_authors = False 82 | 83 | # The name of the Pygments (syntax highlighting) style to use. 84 | pygments_style = 'sphinx' 85 | 86 | # A list of ignored prefixes for module index sorting. 87 | #modindex_common_prefix = [] 88 | 89 | # If true, keep warnings as "system message" paragraphs in the built documents. 90 | #keep_warnings = False 91 | 92 | 93 | # -- Options for HTML output --------------------------------------------------- 94 | 95 | # The theme to use for HTML and HTML Help pages. See the documentation for 96 | # a list of builtin themes. 97 | html_theme = 'default' 98 | 99 | # Theme options are theme-specific and customize the look and feel of a theme 100 | # further. For a list of options available for each theme, see the 101 | # documentation. 102 | #html_theme_options = {} 103 | 104 | # Add any paths that contain custom themes here, relative to this directory. 105 | #html_theme_path = [] 106 | 107 | # The name for this set of Sphinx documents. If None, it defaults to 108 | # " v documentation". 109 | #html_title = None 110 | 111 | # A shorter title for the navigation bar. Default is the same as html_title. 112 | #html_short_title = None 113 | 114 | # The name of an image file (relative to this directory) to place at the top 115 | # of the sidebar. 116 | #html_logo = None 117 | 118 | # The name of an image file (within the static path) to use as favicon of the 119 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 120 | # pixels large. 121 | #html_favicon = None 122 | 123 | # Add any paths that contain custom static files (such as style sheets) here, 124 | # relative to this directory. They are copied after the builtin static files, 125 | # so a file named "default.css" will overwrite the builtin "default.css". 126 | html_static_path = ['_static'] 127 | 128 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 129 | # using the given strftime format. 130 | #html_last_updated_fmt = '%b %d, %Y' 131 | 132 | # If true, SmartyPants will be used to convert quotes and dashes to 133 | # typographically correct entities. 134 | #html_use_smartypants = True 135 | 136 | # Custom sidebar templates, maps document names to template names. 137 | #html_sidebars = {} 138 | 139 | # Additional templates that should be rendered to pages, maps page names to 140 | # template names. 141 | #html_additional_pages = {} 142 | 143 | # If false, no module index is generated. 144 | #html_domain_indices = True 145 | 146 | # If false, no index is generated. 147 | #html_use_index = True 148 | 149 | # If true, the index is split into individual pages for each letter. 150 | #html_split_index = False 151 | 152 | # If true, links to the reST sources are added to the pages. 153 | #html_show_sourcelink = True 154 | 155 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 156 | #html_show_sphinx = True 157 | 158 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 159 | #html_show_copyright = True 160 | 161 | # If true, an OpenSearch description file will be output, and all pages will 162 | # contain a tag referring to it. The value of this option must be the 163 | # base URL from which the finished HTML is served. 164 | #html_use_opensearch = '' 165 | 166 | # This is the file name suffix for HTML files (e.g. ".xhtml"). 167 | #html_file_suffix = None 168 | 169 | # Output file base name for HTML help builder. 170 | htmlhelp_basename = 'simplegistdoc' 171 | 172 | 173 | # -- Options for LaTeX output -------------------------------------------------- 174 | 175 | latex_elements = { 176 | # The paper size ('letterpaper' or 'a4paper'). 177 | #'papersize': 'letterpaper', 178 | 179 | # The font size ('10pt', '11pt' or '12pt'). 180 | #'pointsize': '10pt', 181 | 182 | # Additional stuff for the LaTeX preamble. 183 | #'preamble': '', 184 | } 185 | 186 | # Grouping the document tree into LaTeX files. List of tuples 187 | # (source start file, target name, title, author, documentclass [howto/manual]). 188 | latex_documents = [ 189 | ('index', 'simplegist.tex', u'simplegist Documentation', 190 | u'Varun Malhotra', 'manual'), 191 | ] 192 | 193 | # The name of an image file (relative to this directory) to place at the top of 194 | # the title page. 195 | #latex_logo = None 196 | 197 | # For "manual" documents, if this is true, then toplevel headings are parts, 198 | # not chapters. 199 | #latex_use_parts = False 200 | 201 | # If true, show page references after internal links. 202 | #latex_show_pagerefs = False 203 | 204 | # If true, show URL addresses after external links. 205 | #latex_show_urls = False 206 | 207 | # Documents to append as an appendix to all manuals. 208 | #latex_appendices = [] 209 | 210 | # If false, no module index is generated. 211 | #latex_domain_indices = True 212 | 213 | 214 | # -- Options for manual page output -------------------------------------------- 215 | 216 | # One entry per manual page. List of tuples 217 | # (source start file, name, description, authors, manual section). 218 | man_pages = [ 219 | ('index', 'simplegist', u'simplegist Documentation', 220 | [u'Varun Malhotra'], 1) 221 | ] 222 | 223 | # If true, show URL addresses after external links. 224 | #man_show_urls = False 225 | 226 | 227 | # -- Options for Texinfo output ------------------------------------------------ 228 | 229 | # Grouping the document tree into Texinfo files. List of tuples 230 | # (source start file, target name, title, author, 231 | # dir menu entry, description, category) 232 | texinfo_documents = [ 233 | ('index', 'simplegist', u'simplegist Documentation', 234 | u'Varun Malhotra', 'simplegist', 'One line description of project.', 235 | 'Miscellaneous'), 236 | ] 237 | 238 | # Documents to append as an appendix to all manuals. 239 | #texinfo_appendices = [] 240 | 241 | # If false, no module index is generated. 242 | #texinfo_domain_indices = True 243 | 244 | # How to display URL addresses: 'footnote', 'no', or 'inline'. 245 | #texinfo_show_urls = 'footnote' 246 | 247 | # If true, do not generate a @detailmenu in the "Top" node's menu. 248 | #texinfo_no_detailmenu = False 249 | --------------------------------------------------------------------------------