Skip to content

Commit

Permalink
added contact + removed doc building
Browse files Browse the repository at this point in the history
  • Loading branch information
matthieu-str committed Feb 18, 2025
1 parent 71249bb commit d4dcc00
Showing 1 changed file with 3 additions and 22 deletions.
25 changes: 3 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected])

<!-- github-only -->

[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
```
[Issue Tracker]: https://github.com/matthieu-str/mescal/issues

0 comments on commit d4dcc00

Please sign in to comment.