Skip to content

Commit

Permalink
Created Readme in markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
DarioArzaba committed Apr 1, 2023
1 parent 1c6de51 commit bec4d51
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 6 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.vscode
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<br />
<div align="center">
<a href="Repo Link">
<img src="sphinxLogo.png" alt="Logo" width="100">
</a>
<h3 align="center">Sphinx Docs Tutorial</h3>
<p align="center">
Example documentation and cheatsheet of this amazing python tool.
<br />
<a href="https://github.com/othneildrew/Best-README-Template"><strong>Explore the docs »</strong></a>
<br />
</p>
</div>


## About

By going over the [Sphinx Docs](https://www.sphinx-doc.org/en/master/) in an attempt to learn how to document my code I inadvertently ended up making a tutorial about the documentation tool itself and a starting point for creating my own documentation in the future.

## Installation

1. Download and install [python](https://www.python.org/downloads/)
2. Clone the repo
```sh
git clone https://github.com/DarioArzaba/Sphinx-Docs-Tutorial
cd Sphinx-Docs-Tutorial
```

## Usage

You can build the project and look at the code to learn how to:

1. Install Sphinx
2. Create Restructured-Text files (Similar to markdown)
3. Create a page dedicated to the API of your program.
1. Create pages dedicated to the modules of your program.
1. Create a Glossary of terms used in your documentation.

</br>
<div align="center"> <p> Read the Docs theme </p> </div>
<img src="Sphinx1.png">

## Roadmap

- [x] Done base tutorial
- [ ] Update the project from 2019
- [ ] Add Advanced Section
- [ ] Modifying the Theme
- [ ] Making a Sphinx Extension

## License

Distributed under the [MIT License](https://mit-license.org/).

## Contact

Dario Arzaba - dario.arzaba@gmail.com
6 changes: 0 additions & 6 deletions README.rst

This file was deleted.

Binary file added Sphinx1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sphinxLogo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bec4d51

Please sign in to comment.