Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions docs/Python-environment/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: distriutions
sidebar_position: 8
---

# Distributions

## Available distributions
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: models
sidebar_position: 3
sidebar_position: 10
---

# Model examples
Expand Down
1 change: 1 addition & 0 deletions docs/examples/metabarcoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
id: metabarcoding
title: Abundances from metabarcoding
sidebar_label: Abundances from metabarcoding
sidebar_position: 1
---

# Abundances from metabarcoding
Expand Down
2 changes: 1 addition & 1 deletion docs/for-developers/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: dev
sidebar_position: 7
sidebar_position: 13
---

# Contribute to TreePPL development
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
id: getting-started
sidebar_position: 2
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
5 changes: 5 additions & 0 deletions getting-started/how_to_cite.md → docs/how_to_cite.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: how_to_cite
sidebar_position: 13
---

# How to cite TreePPL

Please cite the [TreePPL Release Note](https://www.biorxiv.org/content/10.1101/2023.10.10.561673v2) when using TreePPL.
Expand Down
18 changes: 12 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@ sidebar_position: 1

# TreePPL Documentation

If you are new to TreePPL, we recommend beginning looking at our [Getting started pages](docs/getting-started).

The TreePPL documentation consists of:

- [Python environment](docs/python-environment), linking to the Python Environment documentation,
- [R environment](docs/R-environment), linking to the R Environment documentation,
- [Model examples](docs/examples), which illustrate key models available in TreePPL,
- [Language reference](docs/language-reference), which contains a language overview, distributions, inference methods, etc.
- [Getting started](docs/getting-started), with instructions for first steps,
- [Python interface](docs/python-interface), with Python Environment documentation,
- [Jupyter interface](docs/jupyter-interface), with Jupyter documentation,
- [R environment](docs/R-environment), linking to the R Environment documentation,
- [Tutorials](docs/tutorials), in which the user learns by doing something meaningful, towards some achievable goal,
<!-- - To be added: System, which is documentation for the people who would like to develop the TreePPL language itself -->
- [Language overview](docs/language-overview), which contains a basic language description,
- [Distributions](docs/distributions), describing available distributions and related information,
- [Inference methods](docs/inference), describing available inference techniques,
- [Model examples](docs/examples), which illustrate key models available in TreePPL,
- [Contribute to TreePPL development](docs/for-developers), which is documentation for the people who would like to develop the TreePPL language itself, including how to install for command-line use.
- [How to cite](docs/how_to_cite), with background references.

If you are new to TreePPL, we recommend beginning looking at our [Getting started pages](getting-started/getting-started).
5 changes: 5 additions & 0 deletions docs/language-reference/inference.md → docs/inference.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: inference
sidebar_position: 9
---

# Inference methods

TreePPL supports several inference methods.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Jupyter interface
sidebar_position: 4
---
# Jupyter interface

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
id: language_overview
sidebar_position: 7
---

# Language overview

## Basic features
Expand Down
8 changes: 0 additions & 8 deletions docs/language-reference/index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
layout: default
title: Python interface
sidebar_position: 3
---
# Python interface

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: tutorials
sidebar_position: 4
sidebar_position: 6
---

# Tutorials
Expand Down
16 changes: 2 additions & 14 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,6 @@ const config = {
},
],
],
plugins: [
[
'@docusaurus/plugin-content-docs',
{
id: 'getting-started',
path: 'getting-started',
routeBasePath: 'getting-started',
sidebarPath: require.resolve('./sidebarsGettingStarted.js'),
// ... other options
},
],
],
themeConfig: {
docs: {
sidebar: {
Expand All @@ -63,10 +51,10 @@ const config = {
// },
items: [
{
to: '/getting-started/getting-started',
to: '/docs/getting-started',
position: 'left',
label: 'Getting Started',
activeBaseRegex: `/getting-started/`
activeBaseRegex: '/docs/'
},
{
type: 'doc',
Expand Down