Welcome to Documentation!

Overview

Motivation

A example project to show how to get started with Sphinx-based documentation.

This is an example about how to add a figure

OSFPGA

A project under OSFPGA foundation [osf]

Getting Started

Dependencies

In general, this project requires specific versions for the following dependencies:

  • python version >3.8

  • Sphinx version >1.8.5

  • Python dependencies

Install the dependencies:

python3 -m pip install -r <path_to_requirements_file>

Note

See full details at install_doc_dependencies_build

A full example is available:

Install Python and Sphinx

For Linux
apt-get install python3 python3-sphinx
For RHEL, CentOS
yum install python3 python3-sphinx

See also

Read more details at [Sphinx documentation](https://www.sphinx-doc.org/en/master/usage/installation.html)

Install Python Packages

python3 -m pip install -r docs/requirements.txt

Build Instructions

Before compiling source codes, please read the Dependencies and ensure correct environment setup

Clone

git clone https://github.com/tangxifan/sphinx_doc_template.git

Build documentation

cd sphinx_doc_template/docs
make html

You can view the documentation under the docs/build/html using a web browser, e.g., Firefox

Appendix

Contact

Xifan Tang xifan@osfpga.org

References

osf

Open-source fpga. URL: www.osfpga.org.

For more information on the OSFPGA see osfpga_web

Indices and tables