From d4dcc00e16e65d9adbf0ba90c9f2ce1cc3629c7a Mon Sep 17 00:00:00 2001 From: matthieu-str Date: Tue, 18 Feb 2025 14:40:58 -0500 Subject: [PATCH] added contact + removed doc building --- README.md | 25 +++---------------------- 1 file changed, 3 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index c32e08f..6b0e7c9 100644 --- a/README.md +++ b/README.md @@ -76,31 +76,12 @@ Distributed under the terms of the [MIT license][License], If you encounter any problems, please [file an issue][Issue Tracker] along with a detailed description. +## Support +Contact [matthieu.souttre@polymtl.ca](mailto:matthieu.souttre@polymtl.ca) [command-line reference]: https://mescal.readthedocs.io/en/latest/usage.html [License]: https://opensource.org/licenses/MIT [Contributor Guide]: https://github.com/matthieu-str/mescal/blob/master/CONTRIBUTING.md -[Issue Tracker]: https://github.com/matthieu-str/mescal/issues - - -## Building the Documentation - -You can build the documentation locally by installing the documentation Conda environment: - -```bash -conda env create -f docs/environment.yaml -``` - -activating the environment - -```bash -conda activate sphinx_mescal -``` - -and [running the build command](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#sphinx-build): - -```bash -sphinx-build docs _build/html --builder=html --jobs=auto --write-all; open _build/html/index.html -``` \ No newline at end of file +[Issue Tracker]: https://github.com/matthieu-str/mescal/issues \ No newline at end of file