https://github.com/sukhmancs/sphinx-practice-docs
This repository serves as a personal Sphinx Tutorial for learning and practicing documentation creation using Sphinx.
https://github.com/sukhmancs/sphinx-practice-docs
Last synced: 11 months ago
JSON representation
This repository serves as a personal Sphinx Tutorial for learning and practicing documentation creation using Sphinx.
- Host: GitHub
- URL: https://github.com/sukhmancs/sphinx-practice-docs
- Owner: sukhmancs
- License: mit
- Created: 2024-02-17T21:16:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-17T21:34:24.000Z (over 2 years ago)
- Last Synced: 2025-05-17T22:35:25.989Z (about 1 year ago)
- Language: C++
- Size: 2.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sphinx-practice-docs
This repository serves as a personal Sphinx Tutorial for learning and practicing documentation creation using Sphinx and doxygen.
## Project Structure
The project folder contains the following directories:
- `docs/`: Contains all the documentation source files, including reStructuredText (rst) files, configuration files (e.g., `conf.py`), and build files.
- `src/`: Contains all the source code files required by Doxygen to generate XML files.
## Sphinx Theme
This documentation project uses the PyData Sphinx Theme, which provides a beautiful and responsive theme for Sphinx documentation. You can find more information about installing and customizing the theme in the [PyData Sphinx Theme User Guide](https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/install.html).
## Getting Started
To get started with this project, follow these steps:
1. Follow the instructions provided in the [Sphinx documentation](https://www.codingwiththomas.com/blog/my-sphinx-best-practice-for-a-multiversion-documentation-in-different-languages) by Thomas.