/symengine.github.io

Docs for SymEngine

Primary LanguageRubyCreative Commons Attribution 4.0 InternationalCC-BY-4.0

About

This is the source branch for the web-presence of the entire Symengine project.

Contributions

To start working on this site, the following workflow is recommended.

Setup

For the first terminal, we will instantiate a jupyter server.

conda env create -f symedocs.yml
conda activate symedocs
jupyter lab

In another terminal, you can and should set up a file-watching task with a server to visualize the completed docs.

sphinx-autobuild docs public

In case you have cloned the repo for the first time, and are modifying an existing tutorial, note that the ipynb files need to be created.

cd docs/
conda run "jupytext --to ipynb firststeps.md"

License

Currently licensed under the flimsiest of licenses, the CC BY 4.0