From 170bec519efe1b129eaa09df1f4ecb42bf22e55c Mon Sep 17 00:00:00 2001 From: Thomas Ramstad Date: Mon, 21 Jun 2021 20:49:53 +0200 Subject: [PATCH] Update README.md Add code blocks --- docs/README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index bd31ba05..7d22422a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,19 +1,27 @@ Dependencies for LBPM documentation # install sphinx +```python pip install Sphinx - +``` # foamatting requires sphinx read-the-docs-theme +```python pip install sphinx-rtd-theme +``` + # equation rendering requires latex and dvipng command +``` sudo apt-get install dvipng sudo apt-get install texlive texstudio sudo apt-get install texlive-latex-recommended texlive-pictures texlive-latex-extra +``` # To build the docs +``` Step 1) install dependencies listed above Step 2) type 'make html' from the docs/ directory Step 3) point your browser at ~/local/doc/build/html/index.html -# \ No newline at end of file +``` +#