Instruction
stringlengths
14
778
input_code
stringlengths
0
4.24k
output_code
stringlengths
1
5.44k
Add more details to Display Board
Extension DisplayBoard ====================== Installation ------------ This extension is included with the core software and only needs to be set up. Setting up ---------- Edit your config.php and add DisplayBoard as an extension.
Extension DisplayBoard ====================== Installation ------------ This extension is included with the core software and only needs to be set up. Setting up ---------- Edit your config.php and add DisplayBoard as an extension. Display Board Today Next Later ------------------------------ This shows a grid...
Update tutorial intro - this has been out of date since March 2019
Introduction ============ This guide will cover some common PyCC functions their basic use cases. The biggest structural difference between older versions of PyCC and v4.0.0 is that the client is divided into sub-clients which each handle a specific set of functionality. Specifically, an instance of ``CitrinationClie...
Introduction ============ This guide will cover some common PyCC functions their basic use cases. The biggest structural difference between older versions of PyCC and v4.0.0 and later is that the client is divided into sub-clients which each handle a specific set of functionality. Specifically, an instance of ``Citri...
Add multinomial example to doc TOC
.. Copyright (C) 2014 Jaakko Luttinen This file is licensed under the MIT License. See LICENSE for a text of the license. Examples ******** .. toctree:: :maxdepth: 1 regression gmm bmm hmm pca lssm lda
.. Copyright (C) 2014 Jaakko Luttinen This file is licensed under the MIT License. See LICENSE for a text of the license. Examples ******** .. toctree:: :maxdepth: 1 multinomial regression gmm bmm hmm pca lssm lda
Use newton title for install guide to replace mitaka
================================= OpenStack High Availability Guide ================================= Abstract ~~~~~~~~ This guide describes how to install and configure OpenStack for high availability. It supplements the OpenStack Installation Guides and assumes that you are familiar with the material in those guid...
================================= OpenStack High Availability Guide ================================= Abstract ~~~~~~~~ This guide describes how to install and configure OpenStack for high availability. It supplements the Installation Tutorials and Guides and assumes that you are familiar with the material in those ...
Document that we want AES-GCM
Welcome to ``cryptography`` =========================== .. warning:: ``cryptography`` is very young, and very incomplete. ``cryptography`` is a Python library which exposes cryptographic primitives and recipes. Why a new crypto library for Python? ------------------------------------ We wanted to address a few...
Welcome to ``cryptography`` =========================== .. warning:: ``cryptography`` is very young, and very incomplete. ``cryptography`` is a Python library which exposes cryptographic primitives and recipes. Why a new crypto library for Python? ------------------------------------ We wanted to address a few...
Add a note about the library status in the docs.
.. title:: Main Page Welcome To retdec-python's Documentation! ========================================= `retdec-python <https://github.com/s3rvac/retdec-python>`_ is a Python library and tools providing easy access to the `retdec.com <https://retdec.com>`_ decompilation service through their public `REST API <https:...
.. title:: Main Page Welcome To retdec-python's Documentation! ========================================= `retdec-python <https://github.com/s3rvac/retdec-python>`_ is a Python library and tools providing easy access to the `retdec.com <https://retdec.com>`_ decompilation service through their public `REST API <https:...
Add link to gh-pages site
Installation ============ On Debian based systems node.js and the node package manger can be installed with:: apt-get install nodejs npm Afterwards the required node.js modules can be installed via:: npm install Currently two modules are required: * http-server - for serving the tutorial * bower -...
Installation ============ On Debian based systems node.js and the node package manger can be installed with:: apt-get install nodejs npm Afterwards the required node.js modules can be installed via:: npm install Currently two modules are required: * http-server - for serving the tutorial * bower -...
Put the links at the end of the document
================== Admin-tools Zinnia ================== Admin-tools-zinnia is package providing new dashboard modules related to your `Zinnia`_ application for `django-admin-tools`_. .. _Zinnia: http://django-blog-zinnia.com/ .. _django-admin-tools: http://pypi.python.org/pypi/django-admin-tools/ Installation =====...
================== Admin-tools Zinnia ================== Admin-tools-zinnia is package providing new dashboard modules related to your `Zinnia`_ application for `django-admin-tools`_. Installation ============ * Install the package on your system: :: $ pip install django-admin-tools $ pip install admin-tools-zi...
Add the max-line-length to the usage help
==== Doc8 ==== Doc8 is a *opinionated* style checker for sphinx (or other) `rst`_ documentation. QuickStart ========== :: pip install doc8 To run doc8 just invoke it against any doc directory:: $ doc8 coolproject/docs Usage ===== :: $ ./doc8 -h usage: doc8 [-h] [--config path] [--allow-long-ti...
==== Doc8 ==== Doc8 is a *opinionated* style checker for sphinx (or other) `rst`_ documentation. QuickStart ========== :: pip install doc8 To run doc8 just invoke it against any doc directory:: $ doc8 coolproject/docs Usage ===== :: $ ./doc8 -h usage: doc8 [-h] [--config path] [--allow-long-ti...
Add build and coverage status
Ravel ===== Ravel is a tool for building Quality-Based Narratives (QBNs), as `pioneered`_ by Failbetter Games, with a syntax inspired by Inkle Studios' `Ink`_ format and YAML. The goals of Ravel are manifold: - Provide a flexible engine for authoring, testing, and running QBNs. - Provide a simple, text-based authori...
Ravel ===== [![Build Status](https://travis-ci.org/eykd/ravel.svg?branch=master)](https://travis-ci.org/eykd/ravel) [![Coverage Status](https://coveralls.io/repos/github/eykd/ravel/badge.svg?branch=master)](https://coveralls.io/github/eykd/ravel?branch=master) Ravel is a tool for building Quality-Based Narratives (Q...
Fix formatting of contributor page
If you would like to contribute to the development of OpenStack, you must follow the steps in this page: http://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: ht...
If you would like to contribute to the development of OpenStack, you must follow the steps in this page: http://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: http://doc...
Add notice about subprotocol name and IANA registration
Swindon-lattice Protocol ======================== The protocol is higher level-protocol on top of websockets that allows routing messages between backends, push from any backend to any user, publish-subscribe and few other useful things. The protocol is designed to cover large number of cases including different appl...
Swindon-lattice Protocol ======================== The protocol is higher level-protocol on top of websockets that allows routing messages between backends, push from any backend to any user, publish-subscribe and few other useful things. The protocol is designed to cover large number of cases including different appl...
Update the docs to hint database timeouts
Plugin configuration options ============================ This plugin can be configured via your ``config/app.php``. It works similar to how all other CakePHP engine-based libraries work (Cache, Email, Log), and as such you can have multiple backends under different names. Here is an example config stanza: .. code:: ...
Plugin configuration options ============================ This plugin can be configured via your ``config/app.php``. It works similar to how all other CakePHP engine-based libraries work (Cache, Email, Log), and as such you can have multiple backends under different names. Here is an example config stanza: .. code:: ...
Add a link to the repository
Fortran 90 ========== External links: * `Fortran Best Practices <https://github.com/qsnake/qsnake/wiki/Fortran-best-practices>`_ Contents: .. toctree:: :maxdepth: 2 src/rosetta.rst src/gotchas.rst
Fortran 90 ========== External links: * `Fortran Best Practices <https://github.com/qsnake/qsnake/wiki/Fortran-best-practices>`_ Contents: .. toctree:: :maxdepth: 2 src/rosetta.rst src/gotchas.rst This web is opensource. If you have ideas for improvement, please send a pull request against the reposit...
Update link for NCI Cloud Resources
*********************** About the TARGET Data *********************** The ISB-CGC currently hosts over 70 terabytes of TARGET_ data in Google Cloud Storage (GCS_) and in BigQuery_. .. _TARGET: https://ocg.cancer.gov/programs/target .. _GCS: https://cloud.google.com/storage/ .. _BigQuery: https://cloud.google.com/bi...
*********************** About the TARGET Data *********************** The ISB-CGC currently hosts over 70 terabytes of TARGET_ data in Google Cloud Storage (GCS_) and in BigQuery_. .. _TARGET: https://ocg.cancer.gov/programs/target .. _GCS: https://cloud.google.com/storage/ .. _BigQuery: https://cloud.google.com/bi...
Add link to GitHub repo; remove unused links
Spaceland: access shapefiles in Python ====================================== Spaceland is a modern Python library for fast, Pythonic access to `ESRI shapefiles`_. Or, at least, that's what it *will* be. While Spaceland is in active development it's still early days and the library isn't yet feature-complete. What it...
Spaceland: access shapefiles in Python ====================================== Spaceland is a modern Python library for fast, Pythonic access to `ESRI shapefiles`_. Or, at least, that's what it *will* be. While Spaceland is in active development it's still early days and the library isn't yet feature-complete. What it...
Fix articles example in the documentation
The Stencil template language ============================= Stencil is a simple and powerful template language for Swift. It provides a syntax similar to Django and Mustache. If you're familiar with these, you will feel right at home with Stencil. .. code-block:: html+django There are {{ articles.count }} articl...
The Stencil template language ============================= Stencil is a simple and powerful template language for Swift. It provides a syntax similar to Django and Mustache. If you're familiar with these, you will feel right at home with Stencil. .. code-block:: html+django There are {{ articles.count }} articl...
Add note that this SDK is a 3rd party package
.. title:: Firebase PHP SDK ############################## Firebase PHP SDK Documentation ############################## This SDK makes it easy to interact with `Google Firebase <https://firebase.google.com>`_ applications. .. code-block:: php $firebase = Firebase::fromServiceAccount(__DIR__.'/google-service-ac...
.. title:: Firebase PHP SDK ############################## Firebase PHP SDK Documentation ############################## This SDK makes it easy to interact with `Google Firebase <https://firebase.google.com>`_ applications. .. note:: This is a 3rd party SDK and not maintained or supported by Firebase or Google. ...
Fix it for real this time.
.. :changelog: Release History =============== Unreleased (2019-07-xx) ----------------------- Added +++++ - `apt_install.sh` in utils/ that lists Ubuntu/apt package requirements. - `load_modules.sh` in utils/ that sets up Raijin environment. Fixed +++++ - Errors being caused by newer version of networkx. Nx 2.3 now ...
.. :changelog: Release History =============== Unreleased (2019-07-xx) ----------------------- Added +++++ - `apt_install.sh` in utils/ that lists Ubuntu/apt package requirements. - `load_modules.sh` in utils/ that sets up Raijin environment. Fixed +++++ - Errors being caused by newer version of networkx. Nx 2.3 now ...
Update the "Getting started" documentation to reflect getting the program from PyPI.
.. _install: Getting started =============== The source code for ``RnaChipIntegrator`` can be obtained from https://github.com/fls-bioinformatics-core/RnaChipIntegrator/releases It's recommended to download either a ``tar.gz`` or ``zip`` archive, unpack and then install using ``pip``, for example by running:: p...
.. _install: Getting started =============== The easiest way to get the latest version of ``RnaChipIntegrator`` is to use Python's ``pip`` utility to install the latest version of the program directly from the `Python Package Index (PyPI) <https://pypi.python.org/pypi/>`_, by doing:: pip install RnaChipIntegrato...
Hide the license rst files, as they are linked directly.
.. :author: Cask Data, Inc. :copyright: Copyright © 2014 Cask Data, Inc. ================================================= CDAP Reference: APIs, Licenses, and Dependencies ================================================= .. toctree:: :maxdepth: 3 Introduction <index> HTTP RESTful API <http-restful-api...
.. :author: Cask Data, Inc. :copyright: Copyright © 2014 Cask Data, Inc. ================================================= CDAP Reference: APIs, Licenses, and Dependencies ================================================= .. toctree:: :maxdepth: 3 Introduction <index> HTTP RESTful API <http-restful-api...
Update readme to point to stable build
========================= The ``lino_book`` package ========================= .. image:: https://readthedocs.org/projects/lino/badge/?version=latest :target: http://lino.readthedocs.io/en/latest/?badge=latest .. image:: https://coveralls.io/repos/github/lino-framework/book/badge.svg?branch=master :target: ht...
========================= The ``lino_book`` package ========================= .. image:: https://readthedocs.org/projects/lino/badge/?version=latest :target: http://lino.readthedocs.io/en/latest/?badge=latest .. image:: https://coveralls.io/repos/github/lino-framework/book/badge.svg?branch=master :target: ht...
Put missing doc in TOC
.. _developer_guide: ========================= IPython developer's guide ========================= This are two categories of developer focused documentation: 1. Documentation for developers of *IPython itself*. 2. Documentation for developers of third party tools and libraries that use IPython. This part of our...
.. _developer_guide: ========================= IPython developer's guide ========================= This are two categories of developer focused documentation: 1. Documentation for developers of *IPython itself*. 2. Documentation for developers of third party tools and libraries that use IPython. This part of our...
Convert code snipped into a doctest
========================= Using Pybtex as a library ========================= Using the BibTeX parser ======================= .. sourcecode:: pycon >>> from pybtex.database.input import bibtex >>> parser = bibtex.Parser() >>> bib_data = parser.parse_file('examples/foo.bib') >>> bib_data.entries.keys...
========================= Using Pybtex as a library ========================= Using the BibTeX parser ======================= .. doctest:: >>> from pybtex.database.input import bibtex >>> parser = bibtex.Parser() >>> bib_data = parser.parse_file('../examples/tugboat/tugboat.bib') >>> print bib_data....
Use two-level table of contents
Web Apollo 2 ------------------------ View `On Github <https://github.com/GMOD/Apollo/blob/master/docs/index.md>`__ Web Apollo 2 - An instantaneous, collaborative, genome annotation editor. The application's technology stack includes a Grails-based Java web application with flexible database backends and a Javascrip...
Web Apollo 2 ------------------------ View `On Github <https://github.com/GMOD/Apollo/blob/master/docs/index.md>`__ Web Apollo 2 - An instantaneous, collaborative, genome annotation editor. The application's technology stack includes a Grails-based Java web application with flexible database backends and a Javascrip...
Add other subpackages to API reference
API Reference ============= .. automodule:: pyeagle :members: :undoc-members:
API Reference ============= .. automodule:: pyeagle :members: :undoc-members: .. automodule:: pyeagle.types :members: :undoc-members: .. automodule:: pyeagle.geometry :members: :undoc-members:
Undo translation of 'in english'.
wallabag Dokumentation ====================== .. image:: ../img/wallabag.png :alt: wallabag Logo :align: center **wallabag** ist eine Read-it-later Applikation: es speichert Websites, indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht. Die Hauptdokumentation für diese Applikat...
wallabag Dokumentation ====================== .. image:: ../img/wallabag.png :alt: wallabag Logo :align: center **wallabag** ist eine Read-it-later Applikation: es speichert Websites, indem es nur den Inhalt behält. Elemente wie Navigation oder Werbung werden gelöscht. Die Hauptdokumentation für diese Applikat...
Remove a level of <ul> tags in user guide
.. title:: User guide: contents .. _user_guide: ========== User Guide ========== Getting started --------------- The following guides cover how to get started with a pmdarima distribution. The easiest solution is simply installing from PyPi, but if you'd like to contribute you'll need to be able to build from source...
.. title:: User guide: contents .. _user_guide: ========== User Guide ========== The following guides cover how to get started with a pmdarima distribution. The easiest solution is simply installing from PyPi, but if you'd like to contribute you'll need to be able to build from source. .. raw:: html <br/> .. t...
Use shields.io instead of pypip.in.
SQLAlchemy-Utils ================ |Build Status| |Version Status| |Downloads| Various utility functions, new data types and helpers for SQLAlchemy. Resources --------- - `Documentation <http://sqlalchemy-utils.readthedocs.org/>`_ - `Issue Tracker <http://github.com/kvesteri/sqlalchemy-utils/issues>`_ - `Code <htt...
SQLAlchemy-Utils ================ |Build Status| |Version Status| |Downloads| Various utility functions, new data types and helpers for SQLAlchemy. Resources --------- - `Documentation <http://sqlalchemy-utils.readthedocs.org/>`_ - `Issue Tracker <http://github.com/kvesteri/sqlalchemy-utils/issues>`_ - `Code <htt...
Add binascii.hexlify to retrieve the Sigfox ID and PAC.
Registering the SiPy with Sigfox -------------------------------- To ensure your device has been provisioned with **Device ID** and **PAC number**, please update to the latest :ref:`firmware <firmware_upgrades>`. In order to send a Sigfox message, you will need to register your SiPy with the Sigfox Backend. Navigate ...
Registering the SiPy with Sigfox -------------------------------- To ensure your device has been provisioned with **Device ID** and **PAC number**, please update to the latest :ref:`firmware <firmware_upgrades>`. In order to send a Sigfox message, you will need to register your SiPy with the Sigfox Backend. Navigate ...
Fix URL to the previous changelog wiki
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Changelog for package turtlebot_teleop ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 2.1.x - hydro, unstable ======================= Forthcoming ----------- 2.1.1 (2013-08-09) ------------------ * Add missing include_directories to the teleop build. * Add absolute namespaces * Rename ...
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Changelog for package turtlebot_teleop ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 2.1.x - hydro, unstable ======================= Forthcoming ----------- 2.1.1 (2013-08-09) ------------------ * Add missing include_directories to the teleop build. * Add absolute namespaces * Rename ...
Remove Indices and Tables section
SymbiFlow Architecture Definitions ================================== ***Warning: This project is a work in progress and many items may be broken.*** This project contains documentation of various FPGA architectures, it is currently concentrating on; * Lattice iCE40 * Artix 7 The aim is to include useful documentat...
SymbiFlow Architecture Definitions ================================== ***Warning: This project is a work in progress and many items may be broken.*** This project contains documentation of various FPGA architectures, it is currently concentrating on; * Lattice iCE40 * Artix 7 The aim is to include useful documentat...
Add documentation of inner modules
Welcome to pip-run documentation! ============================= .. toctree:: :maxdepth: 1 history .. automodule:: pip_run :members: :undoc-members: :show-inheritance: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`
Welcome to pip-run documentation! ============================= .. toctree:: :maxdepth: 1 history .. automodule:: pip_run :members: :undoc-members: :show-inheritance: .. automodule:: pip_run.commands :members: :undoc-members: :show-inheritance: .. automodule:: pip_run.deps :membe...
Fix spurious = in dib-python readme
=========== dib=-python =========== Adds a symlink to /usr/local/bin/dib-python which points at either a python2 or python3 executable. This is useful for creating #! lines for scripts that are compatible with both python2 and python3. This does not install a python if one does not exist, and instead fails.
========== dib-python ========== Adds a symlink to /usr/local/bin/dib-python which points at either a python2 or python3 executable. This is useful for creating #! lines for scripts that are compatible with both python2 and python3. This does not install a python if one does not exist, and instead fails.
Fix example in documentation, NFC
.. title:: clang-tidy - modernize-replace-random-shuffle modernize-replace-random-shuffle ================================ This check will find occurrences of ``std::random_shuffle`` and replace it with ``std::shuffle``. In C++17 ``std::random_shuffle`` will no longer be available and thus we need to replace it. Bel...
.. title:: clang-tidy - modernize-replace-random-shuffle modernize-replace-random-shuffle ================================ This check will find occurrences of ``std::random_shuffle`` and replace it with ``std::shuffle``. In C++17 ``std::random_shuffle`` will no longer be available and thus we need to replace it. Bel...
Add version and license images.
.. image:: http://vmlaker.github.io/coils/logo.png :alt: Coils Logo :target: http://vmlaker.github.io/coils .. image:: https://api.travis-ci.org/vmlaker/coils.png?branch=master :alt: Build Result Image :target: https://travis-ci.org/vmlaker/coils Coils ===== Read `the docs <http://vmlaker.github.io/coils>`_....
.. image:: http://vmlaker.github.io/coils/logo.png :alt: Coils Logo :target: http://vmlaker.github.io/coils .. image:: https://img.shields.io/pypi/v/coils.svg :alt: Pypi version :target: https://pypi.python.org/pypi/coils .. image:: https://api.travis-ci.org/vmlaker/coils.png?branch=master :alt: Build Result ...
Add performance tips for modeling
.. note that if this is changed from the default approach of using an *include* (in index.rst) to a separate performance page, the header needs to be changed from === to ***, the filename extension needs to be changed from .inc.rst to .rst, and a link needs to be added in the subpackage toctree .. _astropy-mo...
.. note that if this is changed from the default approach of using an *include* (in index.rst) to a separate performance page, the header needs to be changed from === to ***, the filename extension needs to be changed from .inc.rst to .rst, and a link needs to be added in the subpackage toctree .. _astropy-mo...
Add note about more warnings in Stratego editor
============= Spoofax 2.5.0 ============= This is a stub for the release notes of Spoofax 2.5.0. See the corresponding :ref:`migration guide <2.5.0-migration-guide>` for migrating from Spoofax 2.4.0 to Spoofax 2.5.0. Changes -------
============= Spoofax 2.5.0 ============= This is a stub for the release notes of Spoofax 2.5.0. See the corresponding :ref:`migration guide <2.5.0-migration-guide>` for migrating from Spoofax 2.4.0 to Spoofax 2.5.0. Changes ------- Stratego ^^^^^^^^ - Stratego editor now gives warnings when using `left`, `right` ...
Add DART client to docs
Literature clients (:py:mod:`indra.literature`) =============================================== .. automodule:: indra.literature :members: Pubmed client (:py:mod:`indra.literature.pubmed_client`) -------------------------------------------------------- .. automodule:: indra.literature.pubmed_client :members:...
Literature clients (:py:mod:`indra.literature`) =============================================== .. automodule:: indra.literature :members: Pubmed client (:py:mod:`indra.literature.pubmed_client`) -------------------------------------------------------- .. automodule:: indra.literature.pubmed_client :members:...
Remove obsolete docs on pep8 sanity test.
:orphan: .. _testing_pep8: ***** PEP 8 ***** .. contents:: Topics `PEP 8`_ style guidelines are enforced by `pycodestyle`_ on all python files in the repository by default. Current Rule Set ================ By default all files are tested using the current rule set. All `PEP 8`_ tests are executed, except those l...
:orphan: .. _testing_pep8: ***** PEP 8 ***** .. contents:: Topics `PEP 8`_ style guidelines are enforced by `pycodestyle`_ on all python files in the repository by default. Running Locally =============== The `PEP 8`_ check can be run locally with:: ansible-test sanity --test pep8 [file-or-directory-path-to...
Replace "mailing lists" with "openstack-discuss" ML
==================== Online Communication ==================== .. image:: ./_assets/os_background.png :class: fill :width: 100% Learning Exercise ================= * Open the `Communication <https://docs.openstack.org/contributors/common/communication.html>`_ section of the Contributor Guide * Read the mat...
==================== Online Communication ==================== .. image:: ./_assets/os_background.png :class: fill :width: 100% Learning Exercise ================= * Open the `Communication <https://docs.openstack.org/contributors/common/communication.html>`_ section of the Contributor Guide * Read the mat...
Add required spacing to readme for proper pypi doc support
.. image:: https://secure.travis-ci.org/josegonzalez/beaver.png ====== Beaver ====== python daemon that munches on logs and sends their contents to logstash Requirements ============ * Python 2.6+ * Optional zeromq support: install libzmq (``brew install zmq`` or ``apt-get install libzmq-dev``) and pyzmq (``pip inst...
.. image:: https://secure.travis-ci.org/josegonzalez/beaver.png ====== Beaver ====== python daemon that munches on logs and sends their contents to logstash Requirements ============ * Python 2.6+ * Optional zeromq support: install libzmq (``brew install zmq`` or ``apt-get install libzmq-dev``) and pyzmq (``pip ins...
Add changelog entry for native string extraction
- **Added:** Support for better extraction of strings in OCaml and Haskell: `ExtOcamlNativeString` provides bindings from the Coq `String` type to the OCaml `string` type, and string literals can be extracted to literals, both in OCaml and Haskell. (`#10486 <https://github.com/coq/coq/pull/10486>`_, by Xavier...
Add rabbit definitions dump resolved issue to relnotes
* RabbitMQ now keeps `users/vhosts/etc` by default and restores it automatically by OCF script. See `LP1383258 <https://bugs.launchpad.net/fuel/+bug/1383258>`_.
Add cost tracking overview documentation
Cost tracking ============= Add-on for NC plugins. It allows to calculate price estimates for resources. How to use ---------- 1. Define CostTrackingStrategy for resource. Example: .. code-block::python class TestNewInstanceCostTrackingStrategy(CostTrackingStrategy): resource_class = test_models.TestN...
Add documentation of LMS/Studio features usable by XBlocks
Integrating XBlocks with edx-platform ===================================== The edX LMS and Studio have several features that are extensions of the core XBlock libraries (https://xblock.readthedocs.org). These features are listed below. LMS --- Runtime Features ~~~~~~~~~~~~~~~~ These are properties and methods avai...
Add initial v2 migration instructions to GMN documentation
GMN v2 migration ================ This section describes how to migrate to GMN v2 from an existing, operational instance of GMN v1. If you are working on a fresh install, start on :setup-local:. * Prepare dependencies $ sudo pip install --upgrade pip virtualenv $ sudo apt-get install libffi-dev * Become the...
Add redeployment with custom settings resolved issue to relnotes
* Resetting and then redeploying an environment with customized Admin (PXE) network settings no longer fails. See `LP1455610 <https://bugs.launchpad.net/fuel/+bug/1455610>`_.
Add group key validation news entry
New features ------------ * Validate key types when accessing groups. Deprecations ------------ * <news item> Exposing HDF5 functions ----------------------- * <news item> Bug fixes --------- * <news item> Building h5py ------------- * <news item> Development ----------- * <news item>
Add some documentation on contributions.
.. _development: Development =========== While skosprovider is still in Alpha development, the basic premise is fairly stable and the API changes have been fairly minor from version to version. We try to cover as much code as we can with unit tests. You can run them using tox_ or directly through nose. When providin...
Add a link to the APUG talk announcement.
DistArray at APUG ================= :tags: talks :slug: 2014-06-11-apug :date: 2014-06-11 :category: Talks Robert Grant presented DistArray to the Austin Python User's group in June 2014. * `Slides`_ * `IPython Notebook`_ .. _Slides: https://github.com/enthought/distarray/blob/master/docs/2014-06-apug/2014-06-apug...
DistArray at APUG ================= :tags: talks :slug: 2014-06-11-apug :date: 2014-06-11 :category: Talks Robert Grant presented DistArray to the Austin Python User's group in June 2014. * `APUG Announcement`_ * `Slides`_ * `IPython Notebook`_ .. _APUG Announcement: http://www.meetup.com/austinpython/events/18396...
Create a test template with an undefined variable in a file content
{{cookiecutter.project_slug}} {% for _ in cookiecutter.project_slug %}={% endfor %} {{cookiecutter.foobar}} https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}
Add install.rst to a toctree
Welcome to the ccdproc documentation! Ccdproc is is an affiliated package for the AstroPy package for basic data reductions of CCD images. The ccdproc package provides many of the necessary tools for processing of ccd images built on a framework to provide error propogation and bad pixel tracking throughout the r...
Welcome to the ccdproc documentation! Ccdproc is is an affiliated package for the AstroPy package for basic data reductions of CCD images. The ccdproc package provides many of the necessary tools for processing of ccd images built on a framework to provide error propogation and bad pixel tracking throughout the r...
Include overview in readme in docs
.. mplstereonet documentation master file, created by sphinx-quickstart on Sun Jun 23 19:10:32 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to mplstereonet's documentation! ======================================== Contents: .. ...
.. include:: ../README.rst Examples ======== .. toctree:: :maxdepth: 2 examples/index Detailed Documentation ====================== .. toctree:: :maxdepth: 3 mplstereonet
Add PairStorage short description, initial configuration
=========== PairStorage ===========
PairStorage =========== PairStorage is internal service used to store run-time key-value parameters in ElasticSearch document for internal usage. Initial configuration --------------------- Before using PairStorage, it's Document, along with all other ConnectionsBundle documents, must be registered in ElasticSearch...
Add a changelog from v2.0.0
Changelog ========= Unreleased ++++++++++ * Add support for Django 2.1 * Add support for Python 3.7 * Drop support for Django 1.10 * Drop support for Python <3.5 (including Python 2) * Adopt the `black`_ style guide .. _black: https://github.com/ambv/black 3.0.0 (2018-02-21) ++++++++++++++++++ * Improve coverage r...
Update warriorframework rst documents for readthedoc
Framework\.ClassUtils\.WSelenium package ======================================== Submodules ---------- Framework\.ClassUtils\.WSelenium\.browser\_mgmt module ------------------------------------------------------ .. automodule:: Framework.ClassUtils.WSelenium.browser_mgmt :members: :undoc-members: :show...
Add user story security and policy enforcement for enterprise IT.
Security / Policy Enforcement for Enterprise IT ========================== *Problem description* --------------------- Many enterprise has stringent security requirements and the security policy must be enforced by IT security. Such security policy must be enforced and applied to all compute resources hosted in the en...
Document some of the inspirations
Inspirations ============ * Python * Syntax * RPython * Low effort metaprogramming * Elements of the type systems * Twisted * Protocol/Transport seperation * Endpoints * Golang * Interfaces * Lightweight processes * Channels * Test framework * Rust * Algebraic data types (as enums) * Pattern matc...
Add stub for OpenStack description
Shared services --------------- NodeConductor is designed to support multiple API-based services for access sharing. Services can range from IaaS to SaaS delivery models. Currently supported services are: OpenStack (private cloud, volume-based VMs) +++++++++++++++++++++++++++++++++++++++++++ OpenStack is a popular o...
Add Content Architecture on docs
Content Architecture ==================== The ``Container`` Model ----------------------- The conventions of a Opps site is the modelo ``opps.containers.models.Container``. Each ``container`` instance is stored in a hierarchical tree to form the content navigation, and an interface for managing the structure of the n...
Add ADR for SDN fallback
6. Add fallback for ecommerce sdn check ------------------------------------------------------------ Status ------ Accepted (August 2020) Context ------- When learners attempt to place an order in ecommerce through our Cybersource flow, edX makes a call to the `ConsolidatedScreeningListAPI` at `trade.gov` to check ...
Add docs for QoS specs
========== volume qos ========== volume v1, v2 volume qos associate -------------------- Associate a QoS specification to a volume type .. program:: volume qos associate .. code:: bash os volume qos associate <qos-specs> <volume-type> .. describe:: <qos-specs> QoS specification to modify ...
Add a placeholder for misc notes
* Boost v1.45 (or older) will cause "dereferencing type-punned pointer" warning with runtime/reduce.h when gcc optimization is enabled. It was fixed as discussed here: https://svn.boost.org/trac/boost/ticket/4538. Version 1.47 seems to have that fix. * On Mac OS X, translator is not tested since building ROSE ...
Fix wrong inventory operator service
Summary ======= Configuration reference ----------------------- .. code-block:: yaml sylius_inventory: # The driver used for persistence layer. driver: ~ # Enable/disable backorders. backorders: true # Array of events for InventoryChangeListener events: ~ #...
Summary ======= Configuration reference ----------------------- .. code-block:: yaml sylius_inventory: # The driver used for persistence layer. driver: ~ # Enable/disable backorders. backorders: true # Array of events for InventoryChangeListener events: ~ #...
Add a release note for IBMZ SIMD
IBM zSystems Vector Extension Facility (SIMD) --------------------------------------------- Added support for SIMD extensions of zSystem (z13, z14, z15), through the universal intrinsics interface. This support leads to performance improvements for all SIMD kernels implemented using the universal intrinsics, including...
Create Numpy 1.10.3 release notes.
NumPy 1.10.3 Release Notes ************************** This release is a bugfix release motivated by a segfault regression. Issues Fixed ============ * gh-6922 BUG: numpy.recarray.sort segfaults on Windows Merged PRs ========== The following PRs have been merged into 1.10.3. When the PR is a backport, the PR number...
Add first take of a read-me
========================================= Deli: Another plotting library for Python ========================================= Currently, this library isn't meant for public consumption. I'm using this as a venue for exploring some design patterns and playing around with fixes for things that bother me about existing ...
Add a few more details to the initial changelog
0.4 (unreleased) ---------------- - Initial release
0.4 (unreleased) ---------------- - Initial release of astropy-helpers. See `APE4 <https://github.com/astropy/astropy-APEs/blob/master/APE4.rst>`_ for details of the motivation and design of this package. - The ``astropy_helpers`` package replaces the following modules in the ``astropy`` package: - ``astrop...
Add whatsnew for true_color option
prompt_toolkit uses pygments styles for syntax highlighting. By default, the colors specified in the style are approximated using a standard 256-color palette. prompt_toolkit also supports 24bit, a.k.a. "true", a.k.a. 16-million color escape sequences which enable compatible terminals to display the exact colors specif...
Add some documentations about database migration script.
# Add a new migration scripts ```shell python3.5 manager.py db revision -m "comment about the changes" ``` Then edit appropriately the generated file. # Update the database to the last version ```shell python3.5 manager.py db upgrade ``` # See the history of the migrations on the current database ```shell python3...
Add some documentation for the advanced search
=============== Advanced Search =============== Introduction ------------ The initial implementation of search for encoded could only search for either string matches or checking to see if particular object attributes match. See: src/encoded/tests/features/search.feature for several examples However BoxIII shows on...
Add changelog entry for test suite
.. change:: :tags: feature, tests :tickets: 855 Created a "test suite" similar to the one for SQLAlchemy, allowing developers of third-party dialects to test their code against a set of Alembic tests that have been specially selected to exercise back-end database operations. At the time of rele...
Add acceptance tests for introducing cuda
Acceptance tests for introducing CUDA ===================================== >>> import xchainer as xc Create array from python list ----------------------------- >>> a = xc.Array((3,), xc.float32, [1, 2, 3], 'cuda:0') >>> a.shape (3,) >>> a.dtype Dtype.float32 >>> a.device cuda:0 Create array from numpy ndarray ---...
Add some basic doc on log handlers
Handlers ======== By default, Plop comes with several handlers, listed below. To replace the default handler with a custom one, use the following code snippet: .. sourcecode:: inline-php $plop = \Plop\Plop::getInstance(); $handlers = $plop->getHandlers(); $handlers[0] = new \Plop\Handler\Datagram('127....
Add IP Range Issue to relnotes
* Deployment will fail with a "Not enough IP addresses" error message if there is an insufficient number of IP addresses. Sample scenarios: * You enable the "Assign public network to all nodes" option and specify an insufficient range of IP addresses. * The number of available IP addresses is less than ...
Add some simple usage docs
Class-based generic views ========================= Many of `Django`_'s class-based generic views can be used with `SQLAlchemy`_ without modification. For those that don't, Tincture attempts to provide substitutions. The APIs of Tincture's generic views differ slightly from `Django`_'s, where appropriate. For example...
Add documentation for Polygon filtering processor
Polygon filtering ================= .. admonition:: Important :class: important This processor is not available by default. Please contact Opendatasoft support team if you want this processor to be activated in your domain. This processor removes geopoints that are not in a given polygon. Setting the processo...
Add a file with a list of contributors
+Repository Authors +================== + +The following people (in alphabetical order) have committed to the Cycstub repository: + + * Robert Carlsen + * Royal Elmore + * Katy Huff + * Matthew Gidden + * Anthony Scopatz + * Paul P.H. Wilson
Reorder history file and add partial entry for new 0.3.0 release.
.. :changelog: Release History --------------- 0.1.0 (2017-01-31) ++++++++++++++++++ * First release on PyPI. 0.2.0 (2017-05-22) ++++++++++++++++++ * Stable beta release.
.. :changelog: Release History --------------- Unreleased (2019-07-xx) +++++++++++++++++++++++ Added ----- * `apt-install.sh` in utils/ that lists Ubuntu/apt package requirements. * `load_modules.sh` in utils/ that sets up Raijin environment. Fixed ----- * Errors being caused by newer version of networkx. Nx 2.3 now ...
Update changes for queue addition
======= retools ======= 0.2 (**tip**) ============= Features -------- - Statistics for the cache is now optional and can be disabled to slightly reduce the Redis queries used to store/retrieve cache data. Internals --------- - Heavily refactored ``Connection`` to not be a class singleton, instead a global_con...
======= retools ======= 0.2 (**tip**) ============= Features -------- - Statistics for the cache is now optional and can be disabled to slightly reduce the Redis queries used to store/retrieve cache data. - Added first revision of worker/job Queue system, with event support. Internals --------- - Heavily refact...
Fix a minor glitch in utilities module docs
Utilities and Helpers Modules ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ These modules contain common utility and helper functions for B-Spline / NURBS curve and surface evaluation operations. Utilities ========= .. automodule:: geomdl.utilities :members: :exclude-members: check_uv, check_knot_vector :undoc-members: ...
Utilities and Helpers Modules ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ These modules contain common utility and helper functions for B-Spline / NURBS curve and surface evaluation operations. Utilities ========= .. automodule:: geomdl.utilities :members: :exclude-members: check_uv, check_knot_vector :undoc-members: ...
Fix rst/markdown issues in readme.md
=========================== MicroPeri for BBC Microbit =========================== MicroPeri is quick and easy to use Python 3 library for turning the BBC Microbit into an external peripheral device or sensor. With it, you can quickly for example read accelerator values, button presses or even write to the LED matrix!...
=========================== MicroPeri for BBC Microbit =========================== MicroPeri is quick and easy to use Python 3 library for turning the BBC Microbit into an external peripheral device or sensor. With it, you can quickly for example read accelerator values, button presses or even write to the LED matrix!...
Add a blurb about distance metric definitions
******************* TurbuStat Tutorials ******************* .. toctree:: :maxdepth: 2 preprocessing_data masking_and_moments applying_apodizing_functions correcting_for_the_beam Statistics ========== .. toctree:: :maxdepth: 2 statistics/bispectrum_example statistics/delta_variance_...
******************* TurbuStat Tutorials ******************* .. toctree:: :maxdepth: 2 preprocessing_data masking_and_moments applying_apodizing_functions correcting_for_the_beam Statistics ========== .. toctree:: :maxdepth: 2 statistics/bispectrum_example statistics/delta_variance_...
Use paver to generate our documentation
================= Hacking on Moksha ================= :Status: Incomplete Getting the code ---------------- | $ git clone git://git.fedorahosted.org/git/moksha Generating Moksha documentation ------------------------------- | $ cd docs | $ make html
================= Hacking on Moksha ================= :Status: Incomplete Getting the code ---------------- | $ git clone git://git.fedorahosted.org/git/moksha Generating Moksha documentation ------------------------------- | $ paver html
Update page type link text in editor manual to match currently used text
Selecting a page type ~~~~~~~~~~~~~~~~~~~~~ .. image:: ../../_static/images/screen09_page_type_selection.png * On the left of the page chooser screen are listed all the types of pages that you can create. Clicking the page type name will take you to the Create new page screen for that page type (see below). * Clickin...
Selecting a page type ~~~~~~~~~~~~~~~~~~~~~ .. image:: ../../_static/images/screen09_page_type_selection.png * On the left of the page chooser screen are listed all the types of pages that you can create. Clicking the page type name will take you to the Create new page screen for that page type (see below). * Clickin...
Update readme with documentation link
====== Metron ====== Current analytics services supported: * Google Analytics * Mixpanel * gaug.es * Google AdWords Conversion Tracking
====== Metron ====== Current analytics services supported: * Google Analytics * Mixpanel * gaug.es * Google AdWords Conversion Tracking Documentation ------------- Documentation can be found online at http://metron.readthedocs.org/
Change sljit version to r143.
Just-in-Time compilation for Berkeley Packet Filter. You need sljit (http://sljit.sourceforge.net/) and mk-configure (http://sourceforge.net/projects/mk-configure/) to build bpfjit. It is recommended to use pkgsrc and install devel/mk-configure. The pkgsrc guide is available here http://www.netbsd.org/docs/pkgsrc/ B...
Just-in-Time Compilation for Berkeley Packet Filter =================================================== PREREQUISITES ------------- You need sljit (http://sljit.sourceforge.net/) and mk-configure (http://sourceforge.net/projects/mk-configure/) to build bpfjit. It is recommended to use pkgsrc and install devel/mk-con...
Add Django 1.7 installation notes
djangocms-grid ============== A Multi Column Plugin for django CMS, that uses a common grid system. Installation ------------ This plugin requires `django CMS` 2.4 or higher to be properly installed. * In your projects `virtualenv`_, run ``pip install djangocms-grid``. * Add ``'djangocms_grid'`` to your ``INSTALLE...
djangocms-grid ============== A Multi Column Plugin for django CMS, that uses a common grid system. Installation ------------ This plugin requires `django CMS` 2.4 or higher to be properly installed. * In your projects `virtualenv`_, run ``pip install djangocms-grid``. * Add ``'djangocms_grid'`` to your ``INSTALLE...
Add more detail to readme
=============================== fitsiochunked =============================== .. image:: https://img.shields.io/travis/mindriot101/fitsiochunked.svg :target: https://travis-ci.org/mindriot101/fitsiochunked Package to efficiently read large fits arrays in object by object * Free software: MIT license * Docume...
=============================== fitsiochunked =============================== .. image:: https://img.shields.io/travis/mindriot101/fitsiochunked.svg :target: https://travis-ci.org/mindriot101/fitsiochunked Package to efficiently read large fits arrays in object by object * Free software: MIT license Feature...
Add explicit link to discid's documentation
libdiscid.compat package ^^^^^^^^^^^^^^^^^^^^^^^^ :mod:`discid` module ~~~~~~~~~~~~~~~~~~~~ The `discid` module provides the same interface as :py:mod:`discid`. Please have a look at its documentation.
libdiscid.compat package ^^^^^^^^^^^^^^^^^^^^^^^^ :mod:`discid` module ~~~~~~~~~~~~~~~~~~~~ The `discid` module provides the same interface as :py:mod:`discid`. Please have a look at its `documentation`__. .. __: https://python-discid.readthedocs.org/en/v1.0.2/api/
Add a little Changelog mention of the 0.0.1 MMMMMMMVP
.. :changelog: ============= Release notes ============= *Don’t let your friends dump git logs into CHANGELOGs™* http://keepachangelog.com/ Kolibri 0.0.1 +++++++++++++ * Begin development of core auth app. * Add core user types (BaseUser, FacilityUser, DeviceOwner) * Add Collections and Roles, implemented usin...
.. :changelog: ============= Release notes ============= *Don’t let your friends dump git logs into CHANGELOGs™* http://keepachangelog.com/ Kolibri 0.0.1 +++++++++++++ * Begin development of core auth app. * Add core user types (BaseUser, FacilityUser, DeviceOwner) * Add Collections and Roles, implemented usin...
Add header to help layout
.. include:: ../README.rst .. warning:: This is the documentation of pyspotify 2.x which is still under heavy development. You're probably looking for the documentation for the `latest stable release <http://pyspotify.mopidy.com/>`__. Table of contents ================= .. toctree:: installation ...
.. include:: ../README.rst Still in development ==================== .. warning:: This is the documentation of pyspotify 2.x which is still under heavy development. You're probably looking for the documentation for the `latest stable release <http://pyspotify.mopidy.com/>`__. Table of contents ==========...
Modify autosummary to list class instead of modules
.. ehrcorral documentation master file, created by sphinx-quickstart on Tue Jul 9 22:26:36 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to EHRCorral's documentation! ====================================== Contents: .. toctree:...
.. ehrcorral documentation master file, created by sphinx-quickstart on Tue Jul 9 22:26:36 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to EHRCorral's documentation! ====================================== Contents: .. toctree:...
Remove git tag from release checklist
#. ``bumpversion ...`` #. Install the package again for local development, but with the new version number: ``python setup.py develop`` #. Run the tests:: python setup.py test tox #. Build the source distribution: ``python setup.py sdist`` #. Test that the sdist installs:: mktmpenv cd dist tar xzvf collectio...
#. ``bumpversion ...`` #. Install the package again for local development, but with the new version number: ``python setup.py develop`` #. Run the tests:: python setup.py test tox #. Build the source distribution: ``python setup.py sdist`` #. Test that the sdist installs:: mktmpenv cd dist tar xzvf collectio...
Update repo URL in readme
************** pyticketswitch ************** A Python interface for Ingresso's TicketSwitch XML API. Installation ------------ Can be installed with pip: pip install git+https://github.com/ingtechteam/pyticketswitch.git Or cloned: git clone https://github.com/ingtechteam/pyticketswitch.git And installed fr...
************** pyticketswitch ************** A Python interface for Ingresso's TicketSwitch XML API. Installation ------------ Can be installed with pip: pip install git+https://github.com/ingresso-group/pyticketswitch.git Or cloned: git clone https://github.com/ingresso-group/pyticketswitch.git And instal...
Change from rtfd to readthedocs.org to get https.
compactor ========= .. image:: https://travis-ci.org/wickman/compactor.svg?branch=master :target: https://travis-ci.org/wickman/compactor compactor is a pure python implementation of libprocess, the actor library underpinning `mesos <https://mesos.apache.org>`_. documentation ============= compactor documentati...
compactor ========= .. image:: https://travis-ci.org/wickman/compactor.svg?branch=master :target: https://travis-ci.org/wickman/compactor compactor is a pure python implementation of libprocess, the actor library underpinning `mesos <https://mesos.apache.org>`_. documentation ============= compactor documentati...
Fix 404 Error in License Badge Link
{{ cookiecutter.project_name }} ================================= .. image:: https://github.com/InsightSoftwareConsortium/{{ cookiecutter.project_name }}/workflows/Build,%20test,%20package/badge.svg :alt: Build Status .. image:: https://img.shields.io/pypi/v/{{ cookiecutter.python_package_name }}.svg :targ...
{{ cookiecutter.project_name }} ================================= .. image:: https://github.com/InsightSoftwareConsortium/{{ cookiecutter.project_name }}/workflows/Build,%20test,%20package/badge.svg :alt: Build Status .. image:: https://img.shields.io/pypi/v/{{ cookiecutter.python_package_name }}.svg :targ...
Add "Using Plotnine" tutorial section
.. _tutorials: ######### Tutorials ######### Miscellaneous ============= .. toctree:: :maxdepth: 1 :glob: tutorials/miscellaneous-*
.. _tutorials: ######### Tutorials ######### Using Plotnine ============== .. toctree:: :maxdepth: 1 :glob: tutorials/using-* Miscellaneous ============= .. toctree:: :maxdepth: 1 :glob: tutorials/miscellaneous-*
Add plugin term for discovery
.. _glossary: ======== Glossary ======== .. glossary:: command line The terminal or console window where you type commands. Command Prompt On Windows, this is the application where commands are typed into a window for execution. conda The package manager for Anaconda. confi...
.. _glossary: ======== Glossary ======== .. glossary:: command line The terminal or console window where you type commands. Command Prompt On Windows, this is the application where commands are typed into a window for execution. conda The package manager for Anaconda. confi...