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

Add docs/demo with ReadTheDocs #65

Closed
8 of 11 tasks
bollwyvl opened this issue Jul 10, 2022 · 3 comments · Fixed by #68
Closed
8 of 11 tasks

Add docs/demo with ReadTheDocs #65

bollwyvl opened this issue Jul 10, 2022 · 3 comments · Fixed by #68

Comments

@bollwyvl
Copy link
Contributor

bollwyvl commented Jul 10, 2022

It would be nice to use ReadTheDocs to get a documentation site up. This could include some generated API docs (especially for the plugin API) for the typescript side of the house, as well as provide more concrete examples of any built-in (or at least monorepo'd) plugins.

With a bit more work, this could also use jupyterlite (or jupyterlite-sphinx and get per-PR-push previews deployed.

Tasks

  • baseline
    • in RTD web ui
      • reserve appropriate site name, e.g jupyterlab-markup.rtfd.io
      • set up preview builds
    • in a PR
      • create .readthedocs.yml
      • capture docs build deps
      • create docs/conf.py
      • create some basic docs examples
  • advanced
    • create environment.yml (so the nodejs version can be pinned along with everything else)
    • set up typedoc
    • use jupyterlite
    • add link-checking
    • automate some screenshots with galata/robot
@bollwyvl
Copy link
Contributor Author

@agoose77 if you fire up the RTD config i can PR the rest!

@agoose77
Copy link
Owner

Thanks @bollwyvl, done!

@bollwyvl
Copy link
Contributor Author

Will get a PR up sometime later today.

agoose77 added a commit to bollwyvl/jupyterlab-markup that referenced this issue Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants