https://github.com/vsevagen/grimoirelab-guide

https://github.com/vsevagen/grimoirelab-guide

Last synced: 20 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/vsevagen/grimoirelab-guide
• Owner: VSevagen
• Created: 2021-07-11T06:08:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-28T07:06:56.000Z (over 3 years ago)
• Last Synced: 2024-11-04T08:42:33.006Z (2 months ago)
• Language: Python
• Homepage: https://grimoirelab-guide.readthedocs.io/en/latest/
• Size: 3.69 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GrimoireLab Guide

This documentation was generated using Sphinx and the theme used is Furo. In order to view it, just visit the following link, https://vsevagen.github.io/Test-documentation/

In order to generate documentation for any component,

- Install sphinx pip install -U sphinx

- Go into your project directory and create a directory docs

- Run sphinx-quickstart. This will setup a source directory and a default conf.py with mininal required config.

- You'll see two files among others, index.rst and conf.py. The former is your landing page and the other is the configuration file.

- In order to generate documentation regarding your python source files, go into conf.py and uncomment the following code and update the project path.

```

# import os

# import sys

# sys.path.insert(0, os.path.abspath('.'))

```

- Run the following line the generate the documentation

```

sphinx-apidoc -f -o  

```

where path-to-output refers to where the generated docs will be stored and path-to-module refers to module path in need of documentation.

- Finally run make html and everything will be built.

This will build all the required file in the\_build/html directory. Open index.htmlin your browser to see the docs