Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #106 from chrisjsewell/develop
Release v0.10.9
- Loading branch information
Showing
16 changed files
with
665 additions
and
278 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
Developer Guide | ||
+++++++++++++++ | ||
|
||
Installation | ||
~~~~~~~~~~~~ | ||
|
||
To install the development version:: | ||
|
||
>> git clone https://github.com/chrisjsewell/ipypublish . | ||
>> cd ipypublish | ||
|
||
and either use the pre-written Conda development environment (recommended):: | ||
|
||
>> conda env create -n ipub_testenv -f conda_dev_env.yaml python=3.6 | ||
>> conda activate ipub_testenv | ||
>> pip install --no-deps -e . | ||
|
||
or install all *via* pip:: | ||
|
||
>> pip install -e .[tests] | ||
|
||
Testing | ||
~~~~~~~ | ||
|
||
|Build Status| |Coverage Status| | ||
|
||
The following will discover and run all unit test: | ||
|
||
.. code:: shell | ||
>> cd ipypublish | ||
>> pytest -v | ||
Coding Style Requirements | ||
~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
The code style is tested using `flake8 <http://flake8.pycqa.org>`__, | ||
with the configuration set in ``.flake8``, and code should be formatted | ||
with `yapf <https://github.com/google/yapf>`__ (configuration set in | ||
``.style.yapf``). | ||
|
||
Installing with ``ipypublish[tests]`` makes the | ||
`pre-commit <https://pre-commit.com/>`__ package available, which will | ||
ensure these tests are passed by reformatting the code and testing for | ||
lint errors before submitting a commit. It can be setup by: | ||
|
||
.. code:: shell | ||
>> cd ipypublish | ||
>> pre-commit install | ||
Optionally you can run ``yapf`` and ``flake8`` separately: | ||
|
||
.. code:: shell | ||
>> yapf -i path/to/file # format file in-place | ||
>> flake8 | ||
Editors like VS Code also have automatic code reformat utilities, which | ||
can check and adhere to this standard. | ||
|
||
Documentation | ||
~~~~~~~~~~~~~ | ||
|
||
The documentation can be created locally by: | ||
|
||
.. code:: shell | ||
>> cd ipypublish/docs | ||
>> make clean | ||
>> make # or make debug | ||
.. |Build Status| image:: https://travis-ci.org/chrisjsewell/ipypublish.svg?branch=master | ||
:target: https://travis-ci.org/chrisjsewell/ipypublish | ||
.. |Coverage Status| image:: https://coveralls.io/repos/github/chrisjsewell/ipypublish/badge.svg?branch=master | ||
:target: https://coveralls.io/github/chrisjsewell/ipypublish?branch=master |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
:orphan: | ||
|
||
.. _latex_ipypublish_all: | ||
|
||
Example Export Configuration | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.. _meta_celllevel_schema: | ||
|
||
Cell/Output Level Metadata Schema | ||
--------------------------------- | ||
|
||
.. literalinclude:: ../../ipypublish/schema/cell_metadata.schema.json | ||
:language: JSON |
Oops, something went wrong.