Merge branch 'master' of https://github.com/najuzilu/sphinxcontrib-prettyproof into add-manifest

Author: AakashGfude

.gitignore

@@ -12,3 +12,4 @@ dist/
 .coverage
 coverage.*
 coverage.xml
+.tox/

.pre-commit-config.yaml

@@ -9,7 +9,11 @@ repos:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-      - id: flake8
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.9
+    hooks:
+    - id: flake8
 
   - repo: https://github.com/psf/black
     rev: 20.8b1

README.md

@@ -1,6 +1,8 @@
 # sphinxcontrib-prettyproof
 
-[![Documentation Status](https://readthedocs.org/projects/sphinxcontrib-prettyproof/badge/?version=latest)](https://sphinxcontrib-prettyproof.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status][rtd-badge]][rtd-link]
+[![Github-CI][github-ci]][github-link]
+[![Coverage Status][codecov-badge]][codecov-link]
 
 **A proof extension for Sphinx**.
 
@@ -29,3 +31,16 @@ extensions = ["sphinxcontrib.prettyproof"]
 ## Documentation
 
 See the [Sphinxcontrib Pretty Proof documentation](https://sphinxcontrib-prettyproof.readthedocs.io/en/latest/) for more information.
+
+
+## Contributing
+
+We welcome all contributions! See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details, and below for guidance specific to sphinxcontrib-prettyproof.
+
+
+[rtd-badge]: https://readthedocs.org/projects/sphinxcontrib-prettyproof/badge/?version=latest
+[rtd-link]: https://sphinxcontrib-prettyproof.readthedocs.io/en/latest/?badge=latest
+[github-ci]: https://github.com/najuzilu/sphinxcontrib-prettyproof/workflows/continuous-integration/badge.svg?branch=master
+[github-link]: https://github.com/najuzilu/sphinxcontrib-prettyproof
+[codecov-badge]: https://codecov.io/gh/najuzilu/sphinxcontrib-prettyproof/branch/master/graph/badge.svg
+[codecov-link]: https://codecov.io/gh/najuzilu/sphinxcontrib-prettyproof

docs/source/index.md

@@ -5,17 +5,22 @@
 
 install
 syntax
+contribute
+testing
 zreferences
 ```
 
-[![Documentation Status](https://readthedocs.org/projects/sphinxcontrib-prettyproof/badge/?version=latest)](https://sphinxcontrib-prettyproof.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status][rtd-badge]][rtd-link]
+[![Github-CI][github-ci]][github-link]
+[![Coverage Status][codecov-badge]][codecov-link]
 
 **A proof extension for Sphinx**.
 
 This package contains a [Sphinx](http://www.sphinx-doc.org/en/master/) extension
 for producing proof, theorem, axiom, lemma, definition, criterion, remark, conjecture,
 corollary, algorithm, exercise, example, property, observation and proposition directives.
 
+
 ```{warning}
 sphinxcontrib-prettyproof `0.0.2` is in a development stage and may change rapidly.
 ```
@@ -58,3 +63,11 @@ extensions = ["sphinxcontrib.prettyproof"]
 ```
 
 you may then build using `make html` and the extension will be used by your `Sphinx` project.
+
+
+[rtd-badge]: https://readthedocs.org/projects/sphinxcontrib-prettyproof/badge/?version=latest
+[rtd-link]: https://sphinxcontrib-prettyproof.readthedocs.io/en/latest/?badge=latest
+[github-ci]: https://github.com/najuzilu/sphinxcontrib-prettyproof/workflows/continuous-integration/badge.svg?branch=master
+[github-link]: https://github.com/najuzilu/sphinxcontrib-prettyproof
+[codecov-badge]: https://codecov.io/gh/najuzilu/sphinxcontrib-prettyproof/branch/master/graph/badge.svg
+[codecov-link]: https://codecov.io/gh/najuzilu/sphinxcontrib-prettyproof

docs/source/install.md

@@ -18,3 +18,14 @@ then run:
 ```bash
 python setup.py install
 ```
+
+## Package development
+
+To install `sphinxcontrib-prettyproof` for package development:
+
+```bash
+git clone https://github.com/najuzilu/sphinxcontrib-prettyproof
+cd sphinxcontrib-prettyproof
+git checkout master
+pip install -e .[all]
+```

docs/source/syntax.md

@@ -8,6 +8,12 @@ This documentation utilized the [Markedly Structured Text (MyST)](https://myst-p
 
 A proof directive can be included using the `proof:proof` pattern. Unlike the other directives provided through this extension, a proof directive does not include any parameters nor does it require any arguments. A proof directive can easily be referenced through [targets](https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing).
 
+The following option is supported:
+
+* `class` : text
+
+	Value of the proof’s class attribute which can be used to add custom CSS or JavaScript.
+
 
 **Example**
 

docs/source/testing.md

@@ -0,0 +1,84 @@
+# Testing
+
+For code tests, `sphinxcontrib-prettyproof` uses [pytest](https://docs.pytest.org/).
+
+Run the tests with the following command:
+
+```shell
+>> cd sphinxcontrib-prettyproof
+>> pip install -e .[testing]
+>> pytest
+```
+
+To run the tests in multiple isolated environments, you can also run [tox](https://tox.readthedocs.io/)
+
+```shell
+>> cd sphinxcontrib-prettyproof
+>> tox
+```
+
+To test the build of documentation run
+
+```shell
+>> cd sphinxcontrib-prettyproof
+>> tox docs-update
+```
+
+or
+
+```shell
+>> cd sphinxcontrib-prettyproof/docs
+>> make clean
+>> make html
+```
+
+## Unit Testing
+
+We use [pytest](https://docs.pytest.org/en/latest/) for testing, [pytest-regression](https://pytest-regressions.readthedocs.io/en/latest/) to regenerate expected outcomes of test and [pytest-cov](https://pytest-cov.readthedocs.io/en/latest/) for checking coverage.
+
+To run tests with coverage and an html coverage report:
+
+```bash
+pytest -v --cov=sphinxcontrib --cov-report=html
+```
+
+## Writing Tests
+
+The module `sphinx.testing` is used to run sphinx builds for tests, in a temporary directory.
+
+If creating a new source folder for test files, folder name should start with `test-`.
+Your folder should reside inside the `tests/books` directory, which has been set as the root directory for tests.
+
+The tests should start with:
+
+```python
+@pytest.mark.sphinx('html', testroot="mybook")
+```
+In the above declaration, `html` builder is used. And `mybook` is the source folder which was created with the name `test-mybook` inside `tests/books` folder.
+
+Sphinx Application API is available as a parameter to all the test functions:
+
+```python
+@pytest.mark.sphinx('html', testroot="mybook")
+def mytest(app):
+```
+
+## Code Style
+
+Code is formatted using [black](https://github.com/ambv/black) and code style is tested using [flake8](http://flake8.pycqa.org) with style configuration set in `.flake8`.
+
+Installing using `[code style]` will make the [pre-commit](https://pre-commit.com/) package available which will make sure the style is met before your commits are submitted. In addition, it will reformat for any lint errors.
+
+To install `pre-commit` run the following
+
+```bash
+cd sphinxcontrib-prettyproof
+pre-commit install
+```
+
+`black` and `flake8` can be run separately:
+
+```shell
+>>> black .
+>>> flake8 .
+```

setup.py

@@ -17,6 +17,27 @@
 
 URL = f"https://github.com/najuzilu/sphinxcontrib-prettyproof/archive/{VERSION}.tar.gz"
 
+# Define all extras
+extras = {
+    "code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],
+    "testing": [
+        "coverage",
+        "pytest>=3.6,<4",
+        "pytest-cov",
+        "pytest-regressions",
+        "beautifulsoup4",
+        "myst-parser",
+    ],
+    "rtd": [
+        "sphinx>=3.0",
+        "sphinx-book-theme",
+        "sphinxcontrib-bibtex",
+        "myst-parser",
+    ],
+}
+
+extras["all"] = set(ii for jj in extras.values() for ii in jj)
+
 setup(
     name="sphinxcontrib-prettyproof",
     version=VERSION,
@@ -35,25 +56,7 @@
     license="BSD",
     packages=find_packages(),
     install_requires=["docutils>=0.15", "sphinx", "sphinx-book-theme"],
-    extras_require={
-        "code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],
-        "testing": [
-            "coverage",
-            "pytest>=3.6,<4",
-            "pytest-cov",
-            "pytest-regressions",
-            "sphinxcontrib.prettyproof",
-            "beautifulsoup4",
-            "myst_parser",
-        ],
-        "rtd": [
-            "sphinx>=3.0",
-            "sphinx-book-theme",
-            "sphinxcontrib-bibtex",
-            "sphinxcontrib.prettyproof",
-            "myst-parser",
-        ],
-    },
+    extras_require=extras,
     package_data={"sphinxcontrib": ["_static/*"]},
     include_package_data=True,
     namespace_packages=["sphinxcontrib"],