diff --git a/Makefile b/Makefile index 35828d65..caf49737 100644 --- a/Makefile +++ b/Makefile @@ -136,8 +136,8 @@ pytest-dep: ## Run tests on the Python package only for optional dependencies. A # # TODO: update and install docs requirements # @cd python/ && $(VENV_BIN)/pytest docs --doctest-glob=*.rst --doctest-continue-on-failure -.PHONY: test-all -test-all: rstest pytest pytest-dep ## Run all tests. ASSUMES: previous build command +.PHONY: test +test: rstest pytest pytest-dep ## Run all tests. ASSUMES: previous build command # Utility # ------- diff --git a/README.md b/README.md index 0a486276..345b800c 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,9 @@ You may find most of these crates in crates.io if you wish to utilize only a par We follow semantic versioning principles. However, before version 1.0.0, the MAJOR.MINOR.BUG format sees the roles of MAJOR and MINOR shifted down a step. This means potential breaking changes might occur between MINOR increments, such -as moving from versions 0.1.0 to 0.2.0. All Python packages and all Rust crates will have the same version amongst their +as moving from versions 0.1.0 to 0.2.0. + +All Python packages and all Rust crates will have the same version amongst their respective languages; however, Python and Rust versioning will differ. ## Latest Development diff --git a/dev_steps.md b/dev_steps.md index 79c7a428..48530f51 100644 --- a/dev_steps.md +++ b/dev_steps.md @@ -36,7 +36,7 @@ For developers who want to contribute or modify PECOS: 5. Run all Python and Rust tests: ```sh - make test-all + make test ``` Note: Make sure you have ran a build command before running tests. diff --git a/python/docs/_static/custom.css b/python/docs/_static/custom.css new file mode 100644 index 00000000..c5662096 --- /dev/null +++ b/python/docs/_static/custom.css @@ -0,0 +1,10 @@ +/* custom.css */ +[data-theme="dark"] .table { + background-color: #232b33; +} + +[data-theme="dark"] .table th, +[data-theme="dark"] .table td { + background-color: #232b33; + border-bottom-color: #506071; +} diff --git a/python/docs/_static/mathconf.js b/python/docs/_static/mathconf.js new file mode 100644 index 00000000..f72c3246 --- /dev/null +++ b/python/docs/_static/mathconf.js @@ -0,0 +1,8 @@ +MathJax.Hub.Config({ + TeX: { + Macros: { + RR: '{\\bf R}', + ket: ['{| #1 \rangle}', 1], + } + } +})