Instruction stringlengths 14 778 | input_code stringlengths 0 4.24k | output_code stringlengths 1 5.44k |
|---|---|---|
Add note about security group. | PANDA: A Newsroom Data Appliance
================================
PANDA wants to be your newsroom data appliance. It provides a place for you to store data, search it, and share it with the rest of your newsroom.
Take the `PANDA Future Users Survey <http://bit.ly/pandasurvey>`_.
Local development & testing
---------... | PANDA: A Newsroom Data Appliance
================================
PANDA wants to be your newsroom data appliance. It provides a place for you to store data, search it, and share it with the rest of your newsroom.
Take the `PANDA Future Users Survey <http://bit.ly/pandasurvey>`_.
Local development & testing
---------... |
Fix link to test file | ``full_clean`` vs ``save``
==========================
Simple experiments with Django model's ``full_clean`` function and when it's
called.
`The "gold" is in the single test file
<blob/master/clean_vs_save/clean_vs_save/tests.py>`_.
For full info please see my blog post `Django’s model save vs full_clean
<http://jame... | ``full_clean`` vs ``save``
==========================
Simple experiments with Django model's ``full_clean`` function and when it's
called.
`The "gold" is in the single test file
<clean_vs_save/clean_vs_save/tests.py>`_.
For full info please see my blog post `Django’s model save vs full_clean
<http://jamescooke.info/... |
Add "Running Locust with Docker" to the TOC | =====================
Locust Documentation
=====================
.. rubric:: Everything you need to know about Locust
.. sidebar:: About locust
Locust is a scalable load testing framework written in Python
* **Website**: `https://locust.io/ <https://locust.io/>`_
* **Source code**: `https://github.com/l... | =====================
Locust Documentation
=====================
.. rubric:: Everything you need to know about Locust
.. sidebar:: About locust
Locust is a scalable load testing framework written in Python
* **Website**: `https://locust.io/ <https://locust.io/>`_
* **Source code**: `https://github.com/l... |
Add restricted particle-hole drudge to documentation | .. _problem_drudges:
Direct support of different problems
------------------------------------
.. py:currentmodule:: drudge
In addition to the algebraic rules, more domain specific knowledge can be added
to drudge subclasses for the convenience of working on specific problems. In
these :py:class:`Drudge` subclasses... | .. _problem_drudges:
Direct support of different problems
------------------------------------
.. py:currentmodule:: drudge
In addition to the algebraic rules, more domain specific knowledge can be added
to drudge subclasses for the convenience of working on specific problems. In
these :py:class:`Drudge` subclasses... |
Use proper reST attribute markup. | Clear the ``sys.last_traceback``, ``sys.last_type`` and ``sys.last_value``
attributes by deleting them instead of setting them to ``None``. This better
matches the behaviour of the Python standard library.
| Clear the :py:attr:`sys.last_traceback`, :py:attr:`sys.last_type`
and :py:attr:`sys.last_value` attributes by deleting them instead
of setting them to ``None``. This better matches the behaviour of
the Python standard library.
|
Create structure of "Installation" page | ============
Installation
============
*TBD*
| ============
Installation
============
Python
======
Windows
-------
*TBD*
MacOS
-----
*TBD*
Linux
-----
*TBD*
Flask
=====
*TBD*
Code editors
============
*TBD*
Atom
----
*TBD*
Sublime Text 3
--------------
*TBD*
PyCharm
-------
*TBD*
|
Update badge URL for Travis | Dectate: a configuration engine for Python frameworks
=======================================================
Dectate is a powerful configuration engine for Python frameworks.
`Read the docs`_
.. _`Read the docs`: http://dectate.readthedocs.org
It is used by Morepath_.
.. _Morepath: http://morepath.readthedocs.org... | Dectate: a configuration engine for Python frameworks
=======================================================
Dectate is a powerful configuration engine for Python frameworks.
`Read the docs`_
.. _`Read the docs`: http://dectate.readthedocs.org
It is used by Morepath_.
.. _Morepath: http://morepath.readthedocs.org... |
Fix description for "Inapt spelling of a word" | Trove
--------
Trove is Database as a Service for Open Stack.
=============================
Usage for integration testing
=============================
If you'd like to start up a fake Trove API daemon for integration testing
with your own tool, run:
.. code-block:: bash
$ ./tools/start-fake-mode.sh
Stop the ... | Trove
--------
Trove is Database as a Service for OpenStack.
=============================
Usage for integration testing
=============================
If you'd like to start up a fake Trove API daemon for integration testing
with your own tool, run:
.. code-block:: bash
$ ./tools/start-fake-mode.sh
Stop the s... |
Install `flake8` and `ipdb` in | Add configs to Ubuntu
=====================
::
sudo apt-get install git git-core vim vim-gnome
git clone https://github.com/strazdas/home
cp -r home/.* ~/
git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim
vim +PluginInstall +qall
| Add configs to Ubuntu
=====================
::
sudo apt-get install git git-core vim vim-gnome
git clone https://github.com/strazdas/home
cp -r home/.* ~/
git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim
vim +PluginInstall +qall
sudo pip3 install flake8 ipython ipd... |
Remove the learn module from docs temporarily | .. zounds documentation master file, created by
sphinx-quickstart on Fri Aug 25 12:43:15 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to zounds' documentation!
==================================
Zounds is a python library for or... | .. zounds documentation master file, created by
sphinx-quickstart on Fri Aug 25 12:43:15 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to zounds' documentation!
==================================
Zounds is a python library for or... |
Add captions to others toctree | Deezer Python's documentation
=============================
Deezer-Python: a friendly wrapper around the `Deezer API`_.
.. _Deezer API: http://developers.deezer.com/api
Installation & usage
--------------------
.. toctree::
:caption: Installation & Usage
:maxdepth: 2
installation
usage
asynchro... | Deezer Python's documentation
=============================
Deezer-Python: a friendly wrapper around the `Deezer API`_.
.. _Deezer API: http://developers.deezer.com/api
Installation & usage
--------------------
.. toctree::
:caption: Installation & Usage
:maxdepth: 2
installation
usage
asynchro... |
Remove extra comma in readme | nose-bleed
==========
**Under Development!**
nose-bleed attempts to stop the pain associated with a large test suite by
only running the tests applicable to the changes in your [git] branch.
Usage
-----
By default, nose-bleed is fully active on all test runs. What this means, is it will attempt to connect to a
cove... | nose-bleed
==========
**Under Development!**
nose-bleed attempts to stop the pain associated with a large test suite by
only running the tests applicable to the changes in your [git] branch.
Usage
-----
By default, nose-bleed is fully active on all test runs. What this means, is it will attempt to connect to a
cove... |
Add Travis and codecov badges | XenZen
======
A Django UI for managing XenServer in the simplest possible way.
Installing
----------
::
$ git clone https://github.com/praekeltfoundation/xenzen.git
$ cd xenzen/
$ virtualenv ve
$ . ./ve/bin/activate
$ pip install -r requirements-dev.txt
Create skeleton/local_settings.py ::
... | XenZen
======
.. image:: https://travis-ci.org/praekeltfoundation/xenzen.svg?branch=develop
:target: https://travis-ci.org/praekeltfoundation/xenzen
.. image:: https://codecov.io/gh/praekeltfoundation/xenzen/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/praekeltfoundation/xenzen
A Django UI for ma... |
Add a link to the project page on PyPI. | ==============
`FITS Viewer`_
==============
Copyright (c) 2016 Jeremie DECOCK (http://www.jdhp.org)
* Web site: http://www.jdhp.org/projects_en.html#fits-viewer
* Source code: https://github.com/jeremiedecock/fits-viewer
* Issue tracker: https://github.com/jeremiedecock/fits-viewer/issues
Description
===========
... | ==============
`FITS Viewer`_
==============
Copyright (c) 2016 Jeremie DECOCK (http://www.jdhp.org)
* Web site: http://www.jdhp.org/projects_en.html#fits-viewer
* Source code: https://github.com/jeremiedecock/fits-viewer
* Issue tracker: https://github.com/jeremiedecock/fits-viewer/issues
* PyAX-12 on PyPI: https:/... |
Modify Module page to try to set up autosummary better | .. currentmodule:: regressors
========
Modules
========
.. autosummary::
regressors.plots
regressors.plots.plot_residuals
regressors.stats
regressors.stats.residuals
Plots
-----
.. autofunction:: regressors.plots.plot_residuals
Stats
-----
.. autofunction:: regressors.stats.residuals
| ========
Modules
========
.. autosummary::
regressors.plots
regressors.plots.plot_residuals
regressors.stats
regressors.stats.residuals
Plots
-----
.. autofunction:: regressors.plots.plot_residuals
Stats
-----
.. autofunction:: regressors.stats.residuals
|
Add missing functions from the summary. | .. _utils:
Utilities
=========
.. module:: gorilla.utils
.. autosummary::
:nosignatures:
get_original_attribute
.. autofunction:: get_original_attribute
.. autofunction:: listify
.. autofunction:: uniquify
| .. _utils:
Utilities
=========
.. module:: gorilla.utils
.. autosummary::
:nosignatures:
get_original_attribute
listify
uniquify
.. autofunction:: get_original_attribute
.. autofunction:: listify
.. autofunction:: uniquify
|
Update history for version 0.4 | History
=======
0.3: 2013-06-02
---------------
- Work with servers operating on non-standard ports
0.2: 2013-03-26
---------------
- Not documented
0.1: Never released
-------------------
- Initial Release
| History
=======
0.4: 2013-10-26
---------------
- Minor updates in the README
- Change requirements to depend on requests above 1.1.0
0.3: 2013-06-02
---------------
- Work with servers operating on non-standard ports
0.2: 2013-03-26
---------------
- Not documented
0.1: Never released
-------------------
- Ini... |
Index page for docs with testable example and license info | .. Elasticsearch documentation master file, created by
sphinx-quickstart on Mon May 6 15:38:41 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Elasticsearch's documentation!
=========================================
.. doctest:... | Python Elasticsearch Client
===========================
Example Usage
-------------
.. testsetup::
import os
from datetime import datetime
index_name = os.environ.get('ES_TEST_INDEX', 'test-index')
from elasticsearch import Elasticsearch
es = Elasticsearch()
es.delete_index(index_name, ignor... |
Add VSCode to PlatformIO IDE section | .. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by app... | .. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by app... |
Fix rally job readme file | Rally job related files
=======================
This directory contains rally tasks and plugins that are run by OpenStack CI.
Structure:
* designate.yaml is rally task that will be run in gates
* plugins - directory where you can add rally plugins. Almost everything in
Rally is plugin. Benchmark context, Benchmark ... | Rally job related files
=======================
This directory contains rally tasks and plugins that are run by OpenStack CI.
Structure:
* designate-designate.yaml is rally task that will be run in gates
* plugins - directory where you can add rally plugins. Almost everything in
Rally is plugin. Benchmark context... |
Add breif information about Expynent | .. Expynent documentation master file, created by
sphinx-quickstart on Mon Oct 2 14:03:11 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Expynent's documentation!
====================================
.. toctree::
:maxdepth:... | .. Expynent documentation master file, created by
sphinx-quickstart on Mon Oct 2 14:03:11 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Expynent: Common Regular Expression Patterns
============================================
expynent is... |
Expand release notes for some new features | What's new in h5py 2.9
======================
Support for old Python
----------------------
Support for Python 3.3 has been dropped.
Support for Python 2.6 has been dropped.
TODO
----
- track order #1098
- VDS, #1126, #1060
- improved support for unicode attributes #1032
- pass file-like objects into ``File`` #110... | What's new in h5py 2.9
======================
New features
------------
* A convenient high-level API for creating virtual datasets, HDF5 objects which
act as a view over one or more real datasets (:issue:`1060`, :issue:`1126`).
See :ref:`vds` for details.
* :class:`h5py.File` can now be constructed with a Python... |
Align contributing doc with oslo's policy | If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
https://docs.openstack.org/infra/manual/developers.html
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
h... | If you would like to contribute to the development of oslo's libraries,
first you must take a look to this page:
https://specs.openstack.org/openstack/oslo-specs/specs/policy/contributing.html
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
https://docs.... |
Add instrument backends to plugin reference | .. _plugin-reference:
=================
Plugin Reference
=================
This section lists Plugins that currently come with WA3. Each package below
represents a particular type of extension (e.g. a workload); each sub-package of
that package is a particular instance of that extension (e.g. the Andebench
workload).... | .. _plugin-reference:
=================
Plugin Reference
=================
This section lists Plugins that currently come with WA3. Each package below
represents a particular type of extension (e.g. a workload); each sub-package of
that package is a particular instance of that extension (e.g. the Andebench
workload).... |
Document Python dependencies for blaze | =======
Install
=======
Installing
~~~~~~~~~~
If you are interested in the development version of Blaze you can
obtain the source from Github.
::
$ git clone git@github.com:ContinuumIO/blaze-core.git
Many of the dependencies ( i.e. llvmpy ) are non-trivial to install.
It is **highly recommend** that you build ... | =======
Install
=======
Installing
~~~~~~~~~~
If you are interested in the development version of Blaze you can
obtain the source from Github.
::
$ git clone git@github.com:ContinuumIO/blaze-core.git
Many of the dependencies ( i.e. llvmpy ) are non-trivial to install.
It is **highly recommend** that you build ... |
Update docs to reflect switch to py.test. | Testing
=======
Continuous integration provided by `Travis CI`_.
**master** (latest stable):
|travis-ci-master|_
**develop** (bleeding edge):
|travis-ci-develop|_
.. _Travis CI: https://travis-ci.org/
.. |travis-ci-master| image:: https://secure.travis-ci.org/dmpayton/django-admin-honeypot.png
.. _travis-ci... | Testing
=======
Continuous integration provided by `Travis CI`_.
**master** (latest stable):
|travis-ci-master|_
**develop** (bleeding edge):
|travis-ci-develop|_
.. _Travis CI: https://travis-ci.org/
.. |travis-ci-master| image:: https://secure.travis-ci.org/dmpayton/django-admin-honeypot.png
.. _travis-ci... |
Use an existing test in the examples for running tests | Testing with tox
----------------
To run a particular test class with tox::
$ tox -e py "-k TestGetConfig"
To run some tests with names matching a string expression::
$ tox -e py "-k generate"
Will run all tests matching "generate", test_generate_files for example.
To run just one method::
$ tox -e p... | Testing with tox
----------------
To run a particular test class with tox::
$ tox -e py '-k TestFindHooks'
To run some tests with names matching a string expression::
$ tox -e py '-k generate'
Will run all tests matching "generate", test_generate_files for example.
To run just one method::
$ tox -e p... |
Add contributors link to readme | ========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/cliff.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
=======================================================
cliff -- C... | ========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/cliff.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
=======================================================
cliff -- C... |
Fix reference to module that moved | .. _api:
#############
Reference/API
#############
.. automodapi:: ginga.canvas.CanvasMixin
:no-inheritance-diagram:
.. automodapi:: ginga.canvas.CanvasObject
:no-inheritance-diagram:
.. automodapi:: ginga.canvas.CompoundMixin
:no-inheritance-diagram:
.. automodapi:: ginga.canvas.coordmap
:no-inheritan... | .. _api:
#############
Reference/API
#############
.. automodapi:: ginga.canvas.CanvasMixin
:no-inheritance-diagram:
.. automodapi:: ginga.canvas.CanvasObject
:no-inheritance-diagram:
.. automodapi:: ginga.canvas.CompoundMixin
:no-inheritance-diagram:
.. automodapi:: ginga.canvas.coordmap
:no-inheritan... |
Update of READEME file info | This is the README file for Garn. A python package that facilitates
effective mass calculations of contact geomety dependence on
transmission.
`Kwant <https://kwant-project.org>`_ is used for calculations.
The documentation of the software can be found in the "docs/html_docs"
directory. Start by opening the "index.h... | This is the README file for Garn. A python package that facilitates
effective mass calculations of contact geomety dependence on
transmission.
`Kwant <https://kwant-project.org>`_ is used for calculations.
The most up to date documentation of the software can be found in the
"doc/build/html" directory. Start by open... |
Tweak the readme to add a bit mode detail. |
=========================
Semantic with our Plugins
=========================
Semantic with our plugins is a web application for searching, discovering, and annotating plugins used in OpenCOR, MAP Client, and CTK applications.
|
==========================
Semantics with our Plugins
==========================
Semantics with our Plugins is the concept of using semantic web technologies to describe our software plugins in order to make them discoverable and reusable. Currently this repository contains a web application for searching, discoverin... |
Add timestamp to the changelog of 0.2.0 | 0.2.0 (WIP)
-----------
- Feature GH-1: Add support to TAP mode of OpenVPN servers by parsing virtual
addresses as MAC and IP both.
- Feature GH-4: Add support to client-config-dir (ccd) and iroute.
- Fix GH-2: **BREAK-COMPATIBILITY** Use real or virtual addresses as the key
of client_list and routing_table, inste... | 0.2.0 (2017-10-20)
------------------
- Feature GH-1: Add support to TAP mode of OpenVPN servers by parsing virtual
addresses as MAC and IP both.
- Feature GH-4: Add support to client-config-dir (ccd) and iroute.
- Fix GH-2: **BREAK-COMPATIBILITY** Use real or virtual addresses as the key
of client_list and routin... |
Add more info to readme | ========
agsadmin
========
agsadmin provides a convenient Python front-end to several REST calls on the ArcGIS Server 10.1+ REST Admin API.
Features
========
- Map/Geoprocessing Services
- start and stop
- get statistics
- get status
- get or set the item info (description, summary, tags, etc.)
- set serv... | ========
agsadmin
========
agsadmin provides a convenient Python front-end to several REST calls on the ArcGIS Server 10.1+ REST Admin API.
Features
========
- Map/Geoprocessing Services
- start and stop
- get statistics
- get status
- get or set the item info (description, summary, tags, etc.)
- set serv... |
Make the quick start a little more friendly. | Drogulus
========
**NB: This is an unfinished work in progress and does not yet work.**
Check out the project's website for more details: http://drogul.us
Drogulus is a resilient federated data store and computation platform designed
for simplicity, security, openness and fun. It's also an exercise in
practical phil... | Drogulus
========
**NB: This is an unfinished work in progress and does not yet work.**
Check out the project's website for more details: http://drogul.us
Drogulus is a resilient federated data store and computation platform designed
for simplicity, security, openness and fun. It's also an exercise in
practical phil... |
Fix badge formats to rst | csv_object_reader
=================
[](https://travis-ci.org/fireyone29/csv_object_reader)
[](https://coveralls.io/r/fireyone29/csv_... | csv_object_reader
=================
.. image:: https://travis-ci.org/fireyone29/csv_object_reader.svg?branch=develop
:target: https://travis-ci.org/fireyone29/csv_object_reader
.. image:: https://coveralls.io/repos/fireyone29/csv_object_reader/badge.svg?branch=develop
:target: https://coveralls.io/r/fireyone29... |
Test my new git settings | **********************************************
Python toolkit for the GitHub API.
**********************************************
Octokit.py is a port of ruby toolkit Octokit.rb, basically it's a wrapper around GitHub API.
Quick start
===========
Making requests
---------------
Consuming resources
----------------... | **********************************************
Python toolkit for the GitHub API.
**********************************************
Octokit.py is a port of ruby gem - Octokit.rb, basically it's just a wrapper around GitHub API.
Quick start
===========
Making requests
---------------
Consuming resources
-------------... |
Add specification to History file | =======
History
=======
1.0.3 (2017-04-16)
------------------
* Add language support
* Improve and fix ui
1.0.0 (2015-07-03)
------------------
* First release on PyPI.
| =======
History
=======
1.2.0 (2017-04-26)
------------------
* Add Spanish Translations
1.0.3 (2017-04-16)
------------------
* Add language support
* Improve and fix ui
1.0.0 (2015-07-03)
------------------
* First release on PyPI.
|
Fix typo in readme (ore -> or) | memorised
=========
.. image:: https://travis-ci.org/1stvamp/memorised.svg?branch=master
:target: https://travis-ci.org/1stvamp/memorised
About
-----
``memorised`` is a python module containing handy ``python-memcached``
decorators and utils.
Specifically the ``memorise`` decorator allows you to quickly and simp... | memorised
=========
.. image:: https://travis-ci.org/1stvamp/memorised.svg?branch=master
:target: https://travis-ci.org/1stvamp/memorised
About
-----
``memorised`` is a python module containing handy ``python-memcached``
decorators and utils.
Specifically the ``memorise`` decorator allows you to quickly and simp... |
Convert readthedocs links for their .org -> .io migration for hosted projects | Django-ratelimit-backend
------------------------
.. image:: https://api.travis-ci.org/brutasse/django-ratelimit-backend.png
:alt: Build Status
:target: https://travis-ci.org/brutasse/django-ratelimit-backend
Rate-limit your login attempts at the authentication backend level. Login
attempts are stored in the ca... | Django-ratelimit-backend
------------------------
.. image:: https://api.travis-ci.org/brutasse/django-ratelimit-backend.png
:alt: Build Status
:target: https://travis-ci.org/brutasse/django-ratelimit-backend
Rate-limit your login attempts at the authentication backend level. Login
attempts are stored in the ca... |
Add installation procedure of cookiecutter to doc | ===========================
tempest-plugin-cookiecutter
===========================
Cookiecutter template for an OpenStack tempest plugin.
* Free software: Apache license
This cookiecutter template will create a tempest plugin directory
within an existing repo. For information on tempest plugins, see
http://docs.op... | ===========================
tempest-plugin-cookiecutter
===========================
Cookiecutter template for an OpenStack tempest plugin.
* Free software: Apache license
This cookiecutter template will create a tempest plugin directory
within an existing repo. For information on tempest plugins, see
http://docs.op... |
Update link to our Telegram channel | aiotg
=====
.. image:: https://travis-ci.org/szastupov/aiotg.svg?branch=master
:target: https://travis-ci.org/szastupov/aiotg
Asynchronous Python API for building Telegram bots, featuring:
- Easy and declarative API
- Hassle-free setup - no need for SSL certificates or static IP
- Built-in support for analytics ... | aiotg
=====
.. image:: https://travis-ci.org/szastupov/aiotg.svg?branch=master
:target: https://travis-ci.org/szastupov/aiotg
Asynchronous Python API for building Telegram bots, featuring:
- Easy and declarative API
- Hassle-free setup - no need for SSL certificates or static IP
- Built-in support for analytics ... |
Add dependencies install in install doc for plugin | Installation
============
Prerequisites
-------------
* GLPI installed >= 9.1
Instructions
------------
**1** - Download last version `here <https://github.com/armadito/armadito-glpi/releases>`_
**2** - Unzip and copy files into a new folder called armadito, i.e. **/<glpi_install_dir>/plugins/armadito**.
**3** - ... | Installation
============
Prerequisites
-------------
* GLPI installed >= 9.1
Instructions
------------
**1** - Download last version `here <https://github.com/armadito/armadito-glpi/releases>`_
**2** - Unzip and copy files into a new folder called armadito, i.e. **/<glpi_install_dir>/plugins/armadito**.
**3** - ... |
Fix Transport and ConnectionPool signatures in docs | API Documentation
=================
.. py:module:: elasticsearch
.. autoclass:: Elasticsearch
.. autoclass:: Transport
.. autoclass:: ConnectionPool
.. autoclass:: Connection
| API Documentation
=================
.. py:module:: elasticsearch
.. autoclass:: Elasticsearch
.. autoclass:: Transport(hosts, connection_class=RequestsHttpConnection, connection_pool_class=ConnectionPool, nodes_to_host_callback=construct_hosts_list, sniff_on_start=False, sniff_after_requests=None, sniff_on_connectio... |
Add OpenSSH as dependency in user documentation | Installation
============
Dependencies
------------
In order for ControlBeast's installation to succeed, you will need those pieces of software:
* `Python`_ version 3.3 or newer
* `Git`_ version 1.8 or newer
* `libssh`_ version 0.5 or newer
* `OpenSSL`_ version 1.0 or newer
* `pyyaml`_ version 3.10 or newer
.. _Py... | Installation
============
Dependencies
------------
In order for ControlBeast's installation to succeed, you will need those pieces of software:
* `Python`_ version 3.3 or newer
* `Git`_ version 1.8 or newer
* `libssh`_ version 0.5 or newer
* `OpenSSL`_ version 1.0 or newer
* `OpenSSH`_ version 6.0 or newer recommen... |
Adjust badges URLs to reflect change of git project name | ### **W. I. P.**
.. image:: https://api.travis-ci.org/ReblochonMasque/sudokuku.svg
:target: https://travis-ci.org/ReblochonMasque/sudokuku
.. image:: https://coveralls.io/repos/github/ReblochonMasque/sudokuku/badge.svg?branch=master
:target: https://coveralls.io/github/ReblochonMasque/sudokuku?branch=master
... | ### **W. I. P.**
.. image:: https://api.travis-ci.org/ReblochonMasque/sudoku.svg
:target: https://travis-ci.org/ReblochonMasque/sudoku
.. image:: https://coveralls.io/repos/github/ReblochonMasque/sudoku/badge.svg
:target: https://coveralls.io/github/ReblochonMasque/sudoku
====================================... |
Document removal of icons in migration guide. | =========
Migration
=========
Below is a list of caveats when migrating from Bootstrap3/django-bootstrap3 to Bootstrap4/django-bootstrap4.
This document only considers the differences between django-bootstrap3 and django-bootstrap4. For the migration guide from Bootstrap 3 to 4, please look at the Bootstrap Docs.
| # Migration
Below is a list of caveats when migrating from Bootstrap3/django-bootstrap3 to Bootstrap4/django-bootstrap4.
This document only considers the differences between django-bootstrap3 and django-bootstrap4. For the migration
guide from Bootstrap 3 to 4, please look at the Bootstrap docs.
## Icons
Bootstrap ... |
Update migration guide to mention ELFileBody renaming | .. _2.1-to-2.2:
#########################
Migrating from 2.1 to 2.2
#########################
Global changes
==============
* The format of a few configuration properties in gatling.conf has changed and must be updated to its new form.
Where the values took the form ``"value1, value2, value3"``, it must be change... | .. _2.1-to-2.2:
#########################
Migrating from 2.1 to 2.2
#########################
Global changes
==============
* The format of a few configuration properties in gatling.conf has changed and must be updated to its new form.
Where the values took the form ``"value1, value2, value3"``, it must be change... |
Update to reflect that we are doing releases to pypi | ************
Deuce Client
************
.. image:: https://api.travis-ci.org/rackerlabs/deuce.png
:alt: Deuce De-Duplication As A Service Client
:source: https://github.com/rackerlabs/deuce-client
:keywords: Deuce, Deduplication, Client
:maintainer: Rackspace Atlanta Data Services Team <ds.atl.rackspace.com>
Deuce ... | ************
Deuce Client
************
.. image:: https://api.travis-ci.org/rackerlabs/deuce.png
:alt: Deuce De-Duplication As A Service Client
:source: https://github.com/rackerlabs/deuce-client
:keywords: Deuce, Deduplication, Client
:maintainer: Rackspace Atlanta Data Services Team <ds.atl.rackspace.com>
Deuce ... |
Move table of contents at the top of the page. | Graphics
========
Quick-start
-----------
The example below shows how to:
#. open a window,
#. draw something,
#. wait for a mouse click,
#. close the window.
.. literalinclude:: ../../../examples/Graphics/window_management_example_1.cpp
:encoding: latin-1
:language: cpp
You should be able to see something l... | Graphics
========
Table of Contents
-----------------
.. toctree::
graphics/window_management
graphics/drawing_commands
graphics/keyboard_mouse_input
graphics/image_display
graphics/dialog_box_example
graphics/mesh_viewer
graphics/interactive_viewer
:maxdepth: 2
Quick-start
-----------
The ... |
Add dl based listing of namespace objects with truncated names | {% block title %}
{{ object.short_name }} {{ object.type.title() }}
{{ "=" * (object.short_name|length + object.type|length + 1) }}
.. dn:{{ object.ref_type }}:: {{ object.name }}
{% endblock %}
{% block toc %}
{% if children %}
.. toctree::
:hidden:
{% for item in children %}
/autoapi/{{ item.id.split(... | {% block title %}
{{ object.short_name }} {{ object.type.title() }}
{{ "=" * (object.short_name|length + object.type|length + 1) }}
{% endblock %}
{% block toc %}
{% if children %}
.. toctree::
:hidden:
{% for item in children %}
/autoapi/{{ item.id.split('.')|join('/') }}/index
{%- endfor %}
{% endi... |
Adjust changes to reflect the pending status of the exception correction. | Changes in v1.2
===============
1.2.2 released on 2020-09-17
----------------------------
* Correct broken Connection.proc.
* Correct IPv6 IRI host oversight.
* Document an ambiguity case of DB-API 2.0 connection creation and the workaround(unix vs host/port).
* DB-API 2.0 connect() failures caused an undesired e... | Changes in v1.2
===============
1.2.2 released on 2020-09-22
----------------------------
* Correct broken Connection.proc.
* Correct IPv6 IRI host oversight.
* Document an ambiguity case of DB-API 2.0 connection creation and the workaround(unix vs host/port).
* (Pending, active in 1.3) DB-API 2.0 connect() failu... |
Add sublock model to docs | .. _volumes:
Block Models
************
Transferring a block model from Resource Estimation software into Mine planning software.
.. image:: /images/VolumeGrid.png
:scale: 80%
Element
-------
.. image:: /images/VolumeGridGeometry.png
:width: 80%
:align: center
.. autoclass:: omf.blockmodel.TensorBlockM... | .. _volumes:
Block Models
************
Transferring a block model from Resource Estimation software into Mine planning software.
.. image:: /images/VolumeGrid.png
:scale: 80%
Element
-------
.. image:: /images/VolumeGridGeometry.png
:width: 80%
:align: center
.. autoclass:: omf.blockmodel.TensorBlockM... |
Structure for drivers in docs | .. meta::
:description: Documentation for splinter, an open source tool for testing web applications
:keywords: splinter, python, tutorial, documentation, web application, tests, atdd, tdd, acceptance tests
+++++++++++++++++++++++++++++++++++++++++++++
automate web application actions using python
+++++++++++... | .. meta::
:description: Documentation for splinter, an open source tool for testing web applications
:keywords: splinter, python, tutorial, documentation, web application, tests, atdd, tdd, acceptance tests
+++++++++++++++++++++++++++++++++++++++++++++
automate web application actions using python
+++++++++++... |
Improve wording and line breaks in introduction. | Welcome to MADAM
================
MADAM is a digital asset management library. It aims to facilitate the handling of image, audio, and video files by helping out with several tasks:
- **Organization:** MADAM helps you to organize media data by providing means to read and store media files. Once the files are store... | Welcome to MADAM
================
MADAM is a digital asset management library. It aims to facilitate the handling
of image, audio, and video files by helping out with several tasks:
- **Organization:** MADAM helps you to organize media data by customizable
backends to read and store media files. Once the files ... |
Update manual func sigs for run/sudo in API docs | ==========
Operations
==========
.. automodule:: fabric.operations
:members:
.. autofunction:: get(remote_path, local_path=None)
.. autofunction:: open_shell(command=None)
.. autofunction:: put(local_path, remote_path, use_sudo=False, mirror_local_mode=False, mode=None)
.. autofunction:: reboot(wa... | ==========
Operations
==========
.. automodule:: fabric.operations
:members:
.. autofunction:: get(remote_path, local_path=None)
.. autofunction:: open_shell(command=None)
.. autofunction:: put(local_path, remote_path, use_sudo=False, mirror_local_mode=False, mode=None)
.. autofunction:: reboot(wa... |
Fix url for readthedocs and travis badge | ===============================
ParcelBrigh API wrapper
===============================
.. image:: https://img.shields.io/travis/onjin/parcelbright.svg
:target: https://travis-ci.org/onjin/parcelbright
.. image:: https://img.shields.io/pypi/v/parcelbright.svg
:target: https://pypi.python.org/pypi/parc... | ===============================
ParcelBrigh API wrapper
===============================
.. image:: https://img.shields.io/travis/onjin/parcelbright-python.svg
:target: https://travis-ci.org/onjin/parcelbright-python
.. image:: https://img.shields.io/pypi/v/parcelbright.svg
:target: https://pypi.python... |
Fix code blocks in readme for Markdown | pbxproj_lint
============
A linter for Xcode .pbxproj files. Currently detects the following issues:
- Missing files (files referenced in project but not present on disk)
- Extraneous files (files present on disk but not referenced in project)
- Missing localizations
It can optionally remove all extraneous files.
U... | pbxproj_lint
============
A linter for Xcode .pbxproj files. Currently detects the following issues:
- Missing files (files referenced in project but not present on disk)
- Extraneous files (files present on disk but not referenced in project)
- Missing localizations
It can optionally remove all extraneous files.
U... |
Convert compute QEMU to RST | ====
QEMU
====
| ====
QEMU
====
From the perspective of the Compute service, the QEMU hypervisor is
very similar to the KVM hypervisor. Both are controlled through libvirt,
both support the same feature set, and all virtual machine images that
are compatible with KVM are also compatible with QEMU.
The main difference is that QEMU does... |
Add required parameters to the Route generation | Custom Action
=============
There are certain cases when built-in action types are not enough.
All you need to do is create your own action template and register it for the ``sylius_grid``.
In the template we will specify the button's icon to be ``mail`` and its colour to be ``purple``.
.. code-block:: twig
{%... | Custom Action
=============
There are certain cases when built-in action types are not enough.
All you need to do is create your own action template and register it for the ``sylius_grid``.
In the template we will specify the button's icon to be ``mail`` and its colour to be ``purple``.
.. code-block:: twig
{%... |
Add citation link to front page table of contents | SunPy Documentation
===================
Welcome to the SunPy documentation. SunPy is a community-developed,
free and open-source solar data analysis environment for Python.
We have a documentation :any:`index <genindex>` and a :any:`module <modindex>` list.
.. toctree::
:maxdepth: 2
guide/index
code_ref/index... | SunPy Documentation
===================
Welcome to the SunPy documentation. SunPy is a community-developed,
free and open-source solar data analysis environment for Python.
We have a documentation :any:`index <genindex>` and a :any:`module <modindex>` list.
.. toctree::
:maxdepth: 2
guide/index
code_ref/index... |
Add JSON to the list | ========
rstcheck
========
.. image:: https://travis-ci.org/myint/rstcheck.svg?branch=master
:target: https://travis-ci.org/myint/rstcheck
:alt: Build status
Checks code blocks in reStructuredText.
This is in addition to the usual docutils reStructuredText syntax check itself.
Installation
============
Fr... | ========
rstcheck
========
.. image:: https://travis-ci.org/myint/rstcheck.svg?branch=master
:target: https://travis-ci.org/myint/rstcheck
:alt: Build status
Checks code blocks in reStructuredText.
This is in addition to the usual docutils reStructuredText syntax check itself.
Installation
============
Fr... |
Change reference to landscape.io to master branch | Python Rubik Solver
===================
.. image:: https://badge.fury.io/py/rubik_solver.svg
:target: https://badge.fury.io/py/rubik_solver
.. image:: https://landscape.io/github/Wiston999/python-rubik/develop/landscape.svg?style=flat
:target: https://landscape.io/github/Wiston999/python-rubik/develop
:alt: ... | Python Rubik Solver
===================
.. image:: https://badge.fury.io/py/rubik_solver.svg
:target: https://badge.fury.io/py/rubik_solver
.. image:: https://landscape.io/github/Wiston999/python-rubik/master/landscape.svg?style=flat
:target: https://landscape.io/github/Wiston999/python-rubik/master
:alt: Co... |
Add reference to contemporary projects | References
==========
- `Underscore.js <http://underscorejs.org>`__: A similar library for
JavaScript
- `Enumerable <http://ruby-doc.org/core-2.0.0/Enumerable.html>`__: A
similar library for Ruby
- `Clojure <http://clojure.org>`__: A functional language whose
standard library has several counterparts in ``... | References
==========
- `Underscore.js <http://underscorejs.org>`__: A similar library for
JavaScript
- `Enumerable <http://ruby-doc.org/core-2.0.0/Enumerable.html>`__: A
similar library for Ruby
- `Clojure <http://clojure.org>`__: A functional language whose
standard library has several counterparts in ``... |
Add reference of notebook in docs | **************************
Storing simulations to HDF
**************************
You can ask TARDIS to store the state of each iteration of the simulation you are
running. To see an example of how this can be achieved see the following jupyter notebook.
:ref:`notebooks/to_hdf.ipynb` | **************************
Storing simulations to HDF
**************************
You can ask TARDIS to store the state of each iteration of the simulation you are
running. To see an example of how this can be achieved see the following jupyter notebook.
:ref:`notebooks/to_hdf.ipynb`
Using HDFWriter
===============... |
Rename the "Quickstart" section to "Tutorial" | ==========
Quickstart
==========
* Start with the :ref:`ref_tutorial_install`
* Set up your :ref:`ref_tutorial_createdb`
* Learn the basics about :ref:`ref_tutorial_queries`
* Make your data accessible via :ref:`ref_tutorial_graphql`
.. toctree::
:maxdepth: 3
install
createdb
queries
graphql
| ========
Tutorial
========
* Start with the :ref:`ref_tutorial_install`
* Set up your :ref:`ref_tutorial_createdb`
* Learn the basics about :ref:`ref_tutorial_queries`
* Make your data accessible via :ref:`ref_tutorial_graphql`
.. toctree::
:maxdepth: 3
install
createdb
queries
graphql
|
Fix link for iPhone app | .. |ext_lnk_app_android_dns_changer| raw:: html
<a target="_blank" href="https://play.google.com/store/apps/details?id=com.burakgon.dnschanger">
DNS Changer <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_app_iphone_dns_override| raw:: html
<a ta... | .. |ext_lnk_app_android_dns_changer| raw:: html
<a target="_blank" href="https://play.google.com/store/apps/details?id=com.burakgon.dnschanger">
DNS Changer <img src="https://raw.githubusercontent.com/cytopia/icons/master/11x11/ext-link.png" />
</a>
.. |ext_lnk_app_iphone_dns_override| raw:: html
<a ta... |
Fix indend in django-taggit example | Support for django-generic-m2m
------------------------------
See :doc:`GenericManyToMany documentation<generic>`.
Support for django-hvad
-----------------------
.. automodule:: autocomplete_light.contrib.hvad
:members:
Support for django-taggit
-------------------------
`django-taggit
<https://github.com/alex... | Support for django-generic-m2m
------------------------------
See :doc:`GenericManyToMany documentation<generic>`.
Support for django-hvad
-----------------------
.. automodule:: autocomplete_light.contrib.hvad
:members:
Support for django-taggit
-------------------------
`django-taggit
<https://github.com/alex... |
Remove 'hidden' directive in top level toc tree | .. include:: intro.rst
.. toctree::
:hidden:
self
.. toctree::
:titlesonly:
:maxdepth: 2
installation
contributing
input_format
references
Developer Documentation
=======================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
| .. include:: intro.rst
.. toctree::
self
.. toctree::
:titlesonly:
:maxdepth: 2
installation
contributing
input_format
references
Developer Documentation
=======================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
Replace edit_all_datasets with Edit all dataset | Notifications
=============
Notifications are sent whenever an important event occur on the portal. They give realtime information about the health of the portal.
It’s possible for users to unsubscribe to the different notification type on their account page.
Quota notifications
-------------------
Notification are... | Notifications
=============
Notifications are sent whenever an important event occur on the portal. They give realtime information about the health of the portal.
It’s possible for users to unsubscribe to the different notification type on their account page.
Quota notifications
-------------------
Notification are... |
Fix spelling on SSO docs | Single Sign-On
==============
SSO in Sentry is handled in one of two ways:
- Via a middleware which handles an upstream proxy dictating the authenticated user
- Via a third party service which implements an authentication pipeline
This documentation describes the latter, which would cover things like Google Apps, Gi... | Single Sign-On
==============
SSO in Sentry is handled in one of two ways:
- Via a middleware which handles an upstream proxy dictating the authenticated user
- Via a third party service which implements an authentication pipeline
This documentation describes the latter, which would cover things like Google Apps, Gi... |
Fix tcp input codec in documentation | .. _logstash-config:
Example Logstash Configuration
------------------------------
Example ``logstash.conf`` for unencrypted TCP transport::
input {
tcp {
host => "127.0.0.1"
port => 5959
mode => server
codec => json
}
}
Example ``logstash.con... | .. _logstash-config:
Example Logstash Configuration
------------------------------
Example ``logstash.conf`` for unencrypted TCP transport::
input {
tcp {
host => "127.0.0.1"
port => 5959
mode => server
codec => json_lines {}
}
}
Example ``log... |
Document how to deploy ToscaWidgets resources in production | ==========
Deployment
==========
:Status: Incomplete
Installing and configuring Moksha
---------------------------------
TODO
Setting up mod_wsgi
-------------------
TODO
Setting up orbited
------------------
TODO
Choosing a message broker
-------------------------
By default Moksha utilizes the embeded Morbid... | ==========
Deployment
==========
:Status: Incomplete
Installing and configuring Moksha
---------------------------------
TODO
Setting up mod_wsgi
-------------------
TODO
Serving ToscaWidgets static resources
-------------------------------------
`Deploying projects which use ToscaWidgets <http://toscawidgets.or... |
Fix formatting of the release task list. | Running the Unit Tests
======================
In my development environment, I have three venvs: 2.7, 3.3 and 3.6. I run
the tests in each of these environments before committing changes.
Once committed, TravisCI runs the tests in 2.7, 3.3, 3.4, 3.5 and 3.6. It will
build pull-request branches also. Travis will em... | Running the Unit Tests
======================
In my development environment, I have three venvs: 2.7, 3.3 and 3.6. I run
the tests in each of these environments before committing changes.
Once committed, TravisCI runs the tests in 2.7, 3.3, 3.4, 3.5 and 3.6. It will
build pull-request branches also. Travis will em... |
Fix spelling in description of exceptions | .. _chaos_monkey:
``chaos_monkey`` Block
~~~~~~~~~~~~~~~~~~~~~~
Key that configures Chaos Monkey
``enabled``
***********
Enable or disable Chaos Monkey
| *Type*: Boolean
| *Default*: ``false``
``mean_time``
*************
Mean time between terminations. If mean_time is n, then the probability of a termina... | .. _chaos_monkey:
``chaos_monkey`` Block
~~~~~~~~~~~~~~~~~~~~~~
Key that configures Chaos Monkey
``enabled``
***********
Enable or disable Chaos Monkey
| *Type*: Boolean
| *Default*: ``false``
``mean_time``
*************
Mean time between terminations. If mean_time is n, then the probability of a termina... |
Update changelog for next release | ==========
Change Log
==========
?.?.?
-----
- Fix to allow the 'get' command to use the temporary environment
variables to modify the url for acquiring the content.
1.1.1
-----
- Fix publishing url to allow the user to modify the url scheme.
1.1.0
-----
- Adds a publish command that communicates with a Press s... | ==========
Change Log
==========
1.1.2
-----
- Fix to allow the 'get' command to use the temporary environment
variables to modify the url for acquiring the content.
1.1.1
-----
- Fix publishing url to allow the user to modify the url scheme.
1.1.0
-----
- Adds a publish command that communicates with a Press s... |
Trim the sails a bit. | .. _manual-scala:
##################
Dropwizard & Scala
##################
.. highlight:: text
.. rubric:: The ``dropwizard-scala`` module provides you with glue code required to write your
Dropwizard services in Scala_.
.. _Scala: http://www.scala-lang.org
Dropwizard :ref:`services <man-core-service>... | .. _manual-scala:
##################
Dropwizard & Scala
##################
.. highlight:: text
.. rubric:: The ``dropwizard-scala`` module provides you with glue code required to write your
Dropwizard services in Scala_.
.. _Scala: http://www.scala-lang.org
Dropwizard :ref:`services <man-core-service>... |
Exclude Changelog from Latex output | About pypercolate
=================
.. only:: latex
.. include:: about-include.rst
.. toctree::
:maxdepth: 2
License <license>
Changelog <changelog>
| About pypercolate
=================
.. only:: latex
.. include:: about-include.rst
.. toctree::
:maxdepth: 2
License <license>
.. only:: not latex
.. toctree::
:maxdepth: 2
Changelog <changelog>
|
Add jkuczm to authors list | Authors and contributors
========================
- Mathijs de Bruin <mathijs at visualspace dot nl> (maintainer)
- Jerome Leclanche <jerome dot leclanche at gmail dot com>
- Jannis [jnns]
- Alexander Schrijver [flupzor]
Plus several others whom I forgot to mention. If I did, fire a pull request
adding your name to th... | Authors and contributors
========================
- Mathijs de Bruin <mathijs at visualspace dot nl> (maintainer)
- Jerome Leclanche <jerome dot leclanche at gmail dot com>
- Jannis [jnns]
- Alexander Schrijver [flupzor]
- Jakub Kuczmarski [jkuczm]
Plus several others whom I forgot to mention. If I did, fire a pull re... |
Remove table of contents from COMP 102 | .. header:: COMP 102: Web Design and Multimedia Publishing
.. footer:: COMP 102: Web Design and Multimedia Publishing
.. index::
Web Design and Multimedia Publishing
Web Design
Multimedia Publishing
Design
Publishing
COMP 102
##############################################
COMP 102: Web Design ... | .. header:: COMP 102: Web Design and Multimedia Publishing
.. footer:: COMP 102: Web Design and Multimedia Publishing
.. index::
Web Design and Multimedia Publishing
Web Design
Multimedia Publishing
Design
Publishing
COMP 102
##############################################
COMP 102: Web Design ... |
Add module logs to doc TOC | .. _alignak_app:
Alignak_App Package
===================
Module contents
---------------
.. automodule:: alignak_app
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
alignak_app.alignak_data
------------------------
.. automodule:: alignak_app.alignak_data
:members:
:undoc-me... | .. _alignak_app:
Alignak_App Package
===================
Module contents
---------------
.. automodule:: alignak_app
:members:
:undoc-members:
:show-inheritance:
Submodules
----------
alignak_app.alignak_data
------------------------
.. automodule:: alignak_app.alignak_data
:members:
:undoc-me... |
Add directive for link to PyEnchant. | .. spelling::
wikis
==============
Installation
==============
Installing sphinxcontrib.spelling
=================================
1. Follow the instructions on the PyEnchant_ site to install
**enchant** and then **PyEnchant**.
2. Install the extension with pip: ``pip install sphinxcontrib-spelling``
Config... | .. spelling::
wikis
==============
Installation
==============
Installing sphinxcontrib.spelling
=================================
1. Follow the instructions on the PyEnchant_ site to install
**enchant** and then **PyEnchant**.
2. Install the extension with pip: ``pip install sphinxcontrib-spelling``
.. _Py... |
Add "Oracle" to jdk doc | .. _java-installation-label:
===================
Java 8 Installation
===================
Prerequisites: :ref:`presto-admin-installation-label` and :ref:`presto-admin-configuration-label`
The Java 1.8 JRE (64-bit), update 45 or higher, is a prerequisite for Presto. If a suitable 64-bit version of Java 8 is already ins... | .. _java-installation-label:
===================
Java 8 Installation
===================
Prerequisites: :ref:`presto-admin-installation-label` and :ref:`presto-admin-configuration-label`
The Oracle Java 1.8 JRE (64-bit), update 45 or higher, is a prerequisite for Presto. If a suitable 64-bit version of Oracle Java 8 ... |
Fix incorrect reference to nowcasting module | .. _reference:
#################
pysteps Reference
#################
:Release: |version|
:Date: |today|
.. module:: pysteps
pysteps reference manual
========================
This reference manual gives a detailed description of the modules, functions
and objects included in pysteps.
.. toctree::
:maxdepth: 2
... | .. _reference:
#################
pysteps Reference
#################
:Release: |version|
:Date: |today|
.. module:: pysteps
pysteps reference manual
========================
This reference manual gives a detailed description of the modules, functions
and objects included in pysteps.
.. toctree::
:maxdepth: 2
... |
Change order of documented classes in warthog.client to emphasize that WarthogClient is the important one | Library
=======
The public API of the Warthog library is maintained in the :mod:`warthog.api`
module. This is done for the purposes of clearly identifying which parts of
the library are public and which parts are internal.
Functionality in the :mod:`warthog.client`, :mod:`warthog.config`, :mod:`warthog.transport`,
an... | Library
=======
The public API of the Warthog library is maintained in the :mod:`warthog.api`
module. This is done for the purposes of clearly identifying which parts of
the library are public and which parts are internal.
Functionality in the :mod:`warthog.client`, :mod:`warthog.config`, :mod:`warthog.transport`,
an... |
Add docs for file operations | File Operations
===============
.. module:: winshell
:synopsis: Copy, rename & delete files
.. moduleauthor:: Tim Golden <mail@timgolden.me.uk>
The Windows shell offers functionality (exposed via Explorer)
to allow files to be copied, renamed and deleted. This includes
features such as an animated progress disp... | |
Add quick and dirty doc about state resolution | State Resolution
================
This section describes why we need state resolution and how it works.
Motivation
-----------
We want to be able to associate some shared state with rooms, e.g. a room name
or members list. This is done by having a current state dictionary that maps
from the pair event type and state ... | |
Add MATLAB content for Progress. | The function ``parpopulate`` works identically to ``populate`` except that it uses a job reservation mechanism to allow multiple processes to populate the same table in parallel without collision.
To enable ``parpopulate``, create the job reservation table ``<package>.Jobs`` which must have the following declaration:
... | |
Add semantic versioning prompt (moved from ievv) | ######################################################
ievv_opensource 5.15.0 releasenotes (Not released yet)
######################################################
************
New features
************
- Script for semantic versioning added (Not implemented anywhere, but for later use if needed)
| |
Add upgrade issue to relnotes | * There is a known issue when a Fuel 6.1 to Fail 7.0 upgrade fails.
One of Keystone's ports fails to bind and the service fails
to start when Fuel Upgrade reverts the environment back to 6.1.
This issue can be worked around by waiting approximately 10 minutes
and then verifying normal operation via ``dockerctl ... | |
Add Code of Conduct to .github folder. (GH-286) | :orphan:
Code of Conduct
===============
Please note that all interactions on
`Python Software Foundation <https://www.python.org/psf-landing/>`__-supported
infrastructure is `covered
<https://www.python.org/psf/records/board/minutes/2014-01-06/#management-of-the-psfs-web-properties>`__
by the `PSF Code of Conduct <h... | |
Add missing toplevel modules to docs. | DistArray API Reference
=======================
:mod:`distarray` Package
------------------------
.. automodule:: distarray.__init__
:members:
:undoc-members:
:show-inheritance:
:mod:`error` Module
-------------------
.. automodule:: distarray.error
:members:
:undoc-members:
:show-inheritanc... | DistArray API Reference
=======================
:mod:`distarray` Package
------------------------
.. automodule:: distarray.__init__
:members:
:undoc-members:
:show-inheritance:
:mod:`__version__` Module
-------------------------
.. automodule:: distarray.__version__
:members:
:undoc-members:
... |
Fix an ugly 'typo' :$ | Topaz
=====
.. image:: https://travis-ci.org/topazproject/topaz.png?branch=master
:target: https://travis-ci.org/topazproject/topaz
An implementation of the Ruby programming language, in Python, using the
RPython VM toolchain. Its goals are simplicity of implementation and
performance.
You'll need to have a fel... | Topaz
=====
.. image:: https://travis-ci.org/topazproject/topaz.png?branch=master
:target: https://travis-ci.org/topazproject/topaz
An implementation of the Ruby programming language, in Python, using the
RPython VM toolchain. Its goals are simplicity of implementation and
performance.
You'll need to have a few... |
Add some initial documentation for the FASWhoPlugin, and hooking it into TG2 | ============
FASWhoPlugin
============
:Authors: Luke Macken
John "J5" Palmieri
:Date: 11 Dec 2009
This plugin provdes authenticate to the Fedora Account System using
the `repoze.who` WSGI middleware.
Authenticating against FAS with TurboGears2
-------------------------------------------
Hooking up the FAS... | |
Add Bill Spotz's lightning talk. | :date: 2014-07-09
:category: Talks
:tags: talks
SciPy 2014 Lightning Talk
=========================
Bill Spotz's lightning talk on the Distributed Array Protocol at Scipy 2014.
* `Recorded presentation`_
.. _Recorded presentation: https://youtu.be/JDrhn0-r9Eg?list=PLYx7XA2nY5GfuhCvStxgbynFNrxr3VFog&t=1942
| |
Add ADR for content library indexes | 1. Index libraries in elasticsearch
-----------------------------------
Status
------
Accepted
Context
-------
The new content libraries reside in blockstore instead of edx-platform's models,
which means that we are no longer able to query databases to get complete
metadata quickly about one or more libraries/xbloc... | |
Document how to build the docs | Building the docs
-----------------
You need:
- conda install sphinx numpydoc
- conda install -c bokeh sphinx-rtd-theme
then inside the ``depfinder/doc`` folder, type ``make html``. The docs will
then be in ``depfinder.doc/_build/html/`` | |
Write social networks sharing documentation | Sharing through social networks
===============================
.. admonition:: Important
:class: important
Since shortcuts to social networks are an optional feature, they are not activated on every OpenDataSoft portal. The activation of shortcuts to social networks entirely depends on the portal administrator... | |
Document how to edit the documentation | =================================
SlicerITKUltrasound Documentation
=================================
This is the documentation for SlicerITKUltrasound. When changes are merged to
*master*, they are automatically built and pushed to
https://kitwaremedical.github.io/SlicerITKUltrasoundDoc/.
For quick edits, click the ... | |
Add the "Swift did not finish copying data" issue to relnotes 7.0 | * Deleting Controller nodes while Swift is copying data
may result in lost images.
Sample scenario:
#. You deploy an environment with Controller nodes.
#. You add new Controller nodes to the environment.
#. Swift starts copying data from the original Controller
nodes to the new ones.
#. You immediate... | |
Create seperate toctree for Fitting | Fitting Documentation
=====================
.. toctree::
:maxdepth: 1
Fitting Perspective <perspectives/fitting/fitting_help>
Polydispersity Distributions <perspectives/fitting/pd_help>
Smearing Computation <perspectives/fitting/sm_help>
Polarisation/Magnetic Scattering <perspectives/fitting/mag_hel... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.