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

Create readthedocs/sphinx site #13

Closed
sverhoeven opened this issue Nov 3, 2022 · 4 comments · Fixed by #49
Closed

Create readthedocs/sphinx site #13

sverhoeven opened this issue Nov 3, 2022 · 4 comments · Fixed by #49

Comments

@sverhoeven
Copy link
Member

sverhoeven commented Nov 3, 2022 •
edited
Loading

The README is becoming large and mixes user and developer docs.

It would be nice to have a documentation site using Sphinx and hosted on Readthedocs.

Use https://i-vresse-bartender.readthedocs.io/ as https://bartender.readthedocs.io/ is already taken.

README could be split into

  • CONTRIBUTING.md
  • docs/index.md
  • docs/usage.md
  • docs/user_management.md
  • docs/configuration.md
@Peter9192
Copy link
Contributor

Or use GH actions bartender.github.io? Ben recently wrote a nice blog about versioned docs on GH pages.

sverhoeven added a commit that referenced this issue Jan 13, 2023
@sverhoeven
Add Sphinx doc site
60309b9 
Refs #13
@sverhoeven sverhoeven mentioned this issue Jan 13, 2023
Merged
@sverhoeven
Copy link
Member Author

Add Markdown support with myst see https://github.com/i-VRESSE/bartender/pull/17/files#r1085534781

@Peter9192
Copy link
Contributor

On myst compatibility with sphinx v6, there are two issues and a merged PR: executablebooks/MyST-Parser#660, executablebooks/MyST-NB#466, executablebooks/MyST-Parser#664, just no new release yet.

@Peter9192 Peter9192 mentioned this issue Feb 3, 2023
Merged
9 tasks
@Peter9192
Copy link
Contributor

Peter9192 commented Feb 9, 2023 •
edited
Loading

To do:

@Peter9192 Peter9192 mentioned this issue Feb 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation i-VRESSE/bartender
2 participants
@sverhoeven @Peter9192