https://github.com/symengine/symengine.github.io
Docs for SymEngine
https://github.com/symengine/symengine.github.io
Last synced: 9 months ago
JSON representation
Docs for SymEngine
- Host: GitHub
- URL: https://github.com/symengine/symengine.github.io
- Owner: symengine
- License: cc-by-4.0
- Created: 2017-10-02T15:53:31.000Z (about 8 years ago)
- Default Branch: sources
- Last Pushed: 2021-05-08T00:36:15.000Z (over 4 years ago)
- Last Synced: 2025-01-26T10:41:41.599Z (11 months ago)
- Language: Ruby
- Homepage: https://symengine.github.io
- Size: 9.51 MB
- Stars: 1
- Watchers: 11
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: Readme.org
- License: LICENSE
Awesome Lists containing this project
README
* 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.
#+begin_src bash
conda env create -f symedocs.yml
conda activate symedocs
jupyter lab
#+end_src
In another terminal, you can and should set up a file-watching task with a server to visualize the completed docs.
#+begin_src bash
sphinx-autobuild docs public
#+end_src
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.
#+begin_src bash
cd docs/
conda run "jupytext --to ipynb firststeps.md"
#+end_src
* License
Currently licensed under the flimsiest of licenses, the CC BY 4.0