Skip to content

Commit 35f1ccf

Browse files
Update from suggestions
1 parent b5d2c0a commit 35f1ccf

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

docs/source/index.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
.. Causal Testing documentation master file, created by
2-
sphinx-quickstart on Thu Nov 11 12:31:23 2021.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
52
63
Welcome to Causal Testing's documentation!
74
==========================================
@@ -34,7 +31,7 @@ system-under-test that is expected to cause a change to some output(s).
3431

3532
.. toctree::
3633
:maxdepth: 2
37-
:caption: Code Docs
34+
:caption: API
3835
:titlesonly:
3936

4037
/autoapi/causal_testing/index

docs/source/installation.rst

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,27 @@ If installing on Windows, ensure `Microsoft Visual C++ <https://docs.microsoft.c
99
Pygraphviz
1010
----------
1111

12-
Pygraphviz can be installed through the conda-forge channel
13-
14-
.. code-block:: console
12+
Pygraphviz can be installed through the conda-forge channel::
1513

1614
conda install -c conda-forge pygraphviz
1715

1816

1917
Alternatively, on Linux systems, this can be done with `sudo apt install graphviz libgraphviz-dev`.
2018

19+
Pip Install
20+
-----------
21+
To install the Causal Testing Framework using :code:`pip` for the latest stable version::
22+
23+
pip install causal-testing-framework
24+
25+
To install with development packages/tools::
26+
27+
pip install causal-testing-framework[dev]
28+
2129
Install from source
2230
-------------------
2331

24-
In future it will be possible to install from PyPI, but for now::
32+
To install from source::
2533

2634
git clone https://github.com/CITCOM-project/CausalTestingFramework
2735
cd CausalTestingFramework
@@ -30,20 +38,20 @@ then, to install a specific release::
3038

3139
git fetch --all --tags --prune
3240
git checkout tags/<tag> -b <branch>
33-
pip install -e .
41+
pip install . # For core API only
42+
pip install -e . # For editable install, useful for development work
3443

3544
e.g. version `1.0.0`::
3645

3746
git fetch --all --tags --prune
3847
git checkout tags/1.0.0 -b version
39-
pip install -e .
48+
pip install .
4049

4150
or to install the latest development version::
4251

43-
pip install -e .
52+
pip install .
4453

45-
Use::
54+
To also install developer tools::
4655

4756
pip install -e .[dev]
4857

49-
to also install developer tools.

0 commit comments

Comments
 (0)