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.

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

Documentation #49

Merged
merged 22 commits into from
Feb 24, 2023
Merged

Documentation #49

merged 22 commits into from
Feb 24, 2023

Conversation

Peter9192
Copy link
Contributor

@Peter9192 Peter9192 commented Feb 3, 2023

Docs preview: https://i-vresse-bartender--49.org.readthedocs.build/en/49/index.html#

Split README.md into multiple separate pages in the documentation.

To do:

  • Split up README.md
  • Add CONTRIBUTING.md
  • Add code of conduct
  • Use myst-parser
    • Development version
    • Use released version of myst-parser with sphinx v6 compatibility
  • Add markdown linter
  • Enable ReadTheDocs integration
  • Rewrite (parts of) documentation (to be more in line with the new structure)

closes #13
closes #28
closes #27

@Peter9192
Copy link
Contributor Author

test:

  1. one
  2. two

@Peter9192 Peter9192 marked this pull request as ready for review February 10, 2023 11:19
@Peter9192
Copy link
Contributor Author

see executablebooks/MyST-Parser#664 for status of myst-parser release

Copy link
Member

@sverhoeven sverhoeven left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks much better.

Can you invite me on rtd use my work email?

Just a small rename

docs/develop.md Outdated Show resolved Hide resolved
Co-authored-by: Stefan Verhoeven <stefan.verhoeven@gmail.com>
@Peter9192 Peter9192 merged commit dc0bc33 into main Feb 24, 2023
@Peter9192 Peter9192 deleted the documentation branch February 24, 2023 10:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants