Skip to content

Commit

Permalink
remove auto Table of Contents generated from removed pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
victorsevero committed Jul 8, 2023
1 parent a5c758f commit 82d3657
Show file tree
Hide file tree
Showing 8 changed files with 0 additions and 118 deletions.
9 changes: 0 additions & 9 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Issue summary](#issue-summary)
- [System information](#system-information)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Issue summary

[Put a detailed description of the issue here.]
Expand Down
10 changes: 0 additions & 10 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [hide-toc: true](#hide-toc-true)
- [404 - Page Not Found](#404---page-not-found)
- [The requested page could not be found.](#the-requested-page-could-not-be-found)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

---
hide-toc: true
---
Expand Down
10 changes: 0 additions & 10 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Stable-retro docs](#stable-retro-docs)
- [Instructions for modifying environment pages](#instructions-for-modifying-environment-pages)
- [Build the Documentation](#build-the-documentation)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Stable-retro docs

This folder contains the documentation for [StableRetro](https://github.com/Farama-Foundation/stableretro).
Expand Down
19 changes: 0 additions & 19 deletions docs/developing.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Development](#development)
- [Install Retro from source](#install-retro-from-source)
- [Prerequisites](#prerequisites)
- [Mac prerequisites](#mac-prerequisites)
- [Windows prerequisites](#windows-prerequisites)
- [Linux prerequisites](#linux-prerequisites)
- [Building Linux and Mac](#building-linux-and-mac)
- [Building Windows](#building-windows)
- [Install Retro UI from source](#install-retro-ui-from-source)
- [macOS](#macos)
- [Linux](#linux)
- [Windows](#windows)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Development

Adding new games can be done without recompiling Stable Retro, but if you need to work on the C++ code or make changes to the UI, you will want to compile Stable Retro from source.
Expand Down
16 changes: 0 additions & 16 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Getting Started](#getting-started)
- [Create a Retro Environment](#create-a-retro-environment)
- [Example Usage](#example-usage)
- [Interactive Script](#interactive-script)
- [Random Agent](#random-agent)
- [Brute](#brute)
- [PPO](#ppo)
- [Integrations](#integrations)
- [Importing ROMs](#importing-roms)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Getting Started

Stable Retro requires one of the supported versions of Python (3,6 to 3.10). Please make sure to install the appropriate distribution for your OS beforehand. Please note that due to compatibility issues with some of the cores, 32-bit operating systems are not supported.
Expand Down
30 changes: 0 additions & 30 deletions docs/integration.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Game Integration](#game-integration)
- [Example Integration](#example-integration)
- [`Level1.state`](#level1state)
- [`data.json`](#datajson)
- [`scenario.json`](#scenariojson)
- [`metadata.json`](#metadatajson)
- [`rom.md`](#rommd)
- [`rom.sha`](#romsha)
- [Integration Files](#integration-files)
- [States](#states)
- [Variable Locations `data.json`](#variable-locations-datajson)
- [Scenario `scenario.json`](#scenario-scenariojson)
- [The Integration UI](#the-integration-ui)
- [Integrating a new ROM](#integrating-a-new-rom)
- [Supported ROM Types](#supported-rom-types)
- [Integrating a Game](#integrating-a-game)
- [Done Condition](#done-condition)
- [Reward Function](#reward-function)
- [Finding Variables](#finding-variables)
- [Common Errors](#common-errors)
- [Using a Custom Integration from Python](#using-a-custom-integration-from-python)
- [Appendix: Types](#appendix-types)
- [Appendix: Operations](#appendix-operations)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Game Integration

Integrating a game means taking a video game ROM file and setting it up as a reinforcement learning environment by defining 3 things:
Expand Down
16 changes: 0 additions & 16 deletions docs/python.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Python API](#python-api)
- [RetroEnv](#retroenv)
- [Actions](#actions)
- [Observations](#observations)
- [Multiplayer Environments](#multiplayer-environments)
- [Replay files](#replay-files)
- [Record](#record)
- [Playback](#playback)
- [Render to Video](#render-to-video)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Python API

## RetroEnv
Expand Down
8 changes: 0 additions & 8 deletions docs/release_notes.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Release Notes](#release-notes)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Release Notes

```{eval-rst}
Expand Down

0 comments on commit 82d3657

Please sign in to comment.