Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Set up documentation #1

Open
gdemonet opened this issue Jan 11, 2021 · 1 comment
Open

Set up documentation #1

gdemonet opened this issue Jan 11, 2021 · 1 comment
Assignees
@gdemonet
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
0.1.0

Comments

@gdemonet
Copy link

gdemonet commented Jan 11, 2021 •
edited
Loading

We want this repository to use Sphinx for its own documentation, as it will help for demonstrating the capabilities of the Sphinx plugin we will later develop.

The documentation should be structured as follows:

  • Introduction
  • Installation
  • Usage
  • Development
    • Reference
    • Design
    • Changelog
@gdemonet gdemonet added this to the 0.1.0 milestone Jan 11, 2021
@NicolasT
Copy link
Contributor

Before installation: "What is this?"

@gdemonet gdemonet self-assigned this Jan 14, 2021
@NicolasT NicolasT added enhancement New feature or request documentation Improvements or additions to documentation labels Jun 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gdemonet gdemonet

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
0.1.0
Development

No branches or pull requests
2 participants
@NicolasT @gdemonet