Skip to content

Commit d8f6268

Browse files
committed
Minor updates
1 parent 0f12363 commit d8f6268

File tree

5 files changed

+20
-5
lines changed

5 files changed

+20
-5
lines changed

config.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ pygmentsUseClasses = true
2020
startLevel = 1
2121

2222
[params]
23+
BookTheme = 'auto'
2324
# (Optional, default true) Controls table of contents visibility on right side of pages.
2425
# Start and end levels can be controlled with markup.tableOfContents setting.
2526
# You can also specify this parameter per page in front matter.
@@ -84,4 +85,4 @@ pygmentsUseClasses = true
8485
# 4. Add an import to the new stylesheet in _custom.scss:
8586
# @import "scriptstyle";
8687

87-
BookLogo = "logo.jpg"
88+
BookLogo = "logo.png"

content/docs/cli/cli_commands/examples/example1/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
weight: 4
3-
title: "DPAPI functions"
3+
title: "CLI Examples"
44
---
55

6-
# DPAPI functions
6+
# CLI Examples
77

88
<span style="font-size:12pt; color:red">Note that this is a living document and the following is subject to change. </span>
99

content/docs/cli/installation/_index.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,21 @@ bookCollapseSection: false
66

77
# Installation
88

9-
The `FAIR CLI` requires [python 3.8+](https://www.python.org/downloads/) and can be installed using [pip:](https://pypi.org/project/fair-cli/)
9+
The FAIR CLI is available to install as a python package, and supports [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fair-cli)](https://pypi.org/project/fair-cli/).
10+
11+
It is recommended to install the FAIR CLI in a virtual environment such as a [venv](https://docs.python.org/3/library/venv.html) or [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) environment
12+
13+
## Create and activate a virtual environment
14+
15+
### venv
16+
[venv instructions](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments)
17+
18+
### Conda
19+
[Conda instructions](https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html#creating-environments)
20+
21+
**Note you will need to ensure the environment is activated each time you use the FAIR CLI**
22+
23+
## Install from pypi using pip (recommended)
1024

1125
```
1226
pip3 install fair-cli

content/logo.png

21.1 KB
Loading

themes/hugo-book

0 commit comments

Comments
 (0)