Skip to content

About

User-facing documentation

Resources

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

33 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

# Colosseum Documentation

This repository contains the restructured documentation for the Colosseum platform, the world's largest RF emulator for wireless research. The documentation is organized into multiple RST files for better readability and navigation on GitHub Pages.

## Building the Documentation

This documentation is written in reStructuredText (RST) format and can be built using [Sphinx](https://www.sphinx-doc.org/). To build the documentation:

1. Install Sphinx: ` pip install sphinx sphinx_rtd_theme `

2. Navigate to the documentation directory and build: ` cd docs make html `

  1. The built HTML documentation will be available in the _build/html directory.

## GitHub Pages Setup

To set up this documentation on GitHub Pages:

  1. Push this repository to GitHub
  2. Enable GitHub Pages in the repository settings
  3. Select the branch and directory you want to use for GitHub Pages
  4. GitHub will automatically build and deploy the documentation

## Contributing

To contribute to this documentation:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes to the relevant RST files
  4. Submit a pull request

## License

[Include appropriate license information here]

## Contact

For questions about Colosseum, please use the contact information provided in the documentation.

About

User-facing documentation

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors