https://github.com/richmetellus/docs_sphinxdoctemplate

This is a template to start writing project documentation using Sphinx
https://github.com/richmetellus/docs_sphinxdoctemplate

documentation markdown python-sphinx restructuredtext sphinx sphinx-doc

Last synced: 2 months ago
JSON representation

This is a template to start writing project documentation using Sphinx

Host: GitHub
URL: https://github.com/richmetellus/docs_sphinxdoctemplate
Owner: richMetellus
License: mit
Created: 2025-03-05T04:18:06.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2025-03-06T07:53:39.000Z (about 1 year ago)
Last Synced: 2025-03-06T08:33:14.848Z (about 1 year ago)
Topics: documentation, markdown, python-sphinx, restructuredtext, sphinx, sphinx-doc
Language: Python
Homepage:
Size: 9.96 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

README

# Sphinx Documentation Template

This is a very useful template I used for creating documentation using
python sphinx.

## Get Started

You only need to install `python` and install `pipenv` as the initial requirements.

1. Install python and `pip`
2. Then use `pip` to install `pipenv`

```console
pip install pipenv --user
```

3. Additionally, install GNU make on your host machine

Once these two are install. To build the document you need to run the following commands

1. Install the python packages and start a python virtual environment:

```python
pipenv install
pipenv shell
```

2. then build the document: open a terminal at the root folder of the document
and then type the following command to build a live document

```python
make livehtml
```

For more information, see the file

```{eval-rst}
- :doc:`index`
```