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

Initial documentation #77

Merged
merged 10 commits into from Apr 15, 2019
Merged

Initial documentation #77

merged 10 commits into from Apr 15, 2019

Conversation

astrofrog
Copy link
Member

@astrofrog astrofrog commented Apr 12, 2019

I've started to tidy up the documentation and add API docs and a very basic getting started that I plan to continue working on later.

No need to review this yet - this needs to be rebased once #75 and #78 are merged

Closes #48

@astrofrog astrofrog changed the title WIP: Initial documentation Initial documentation Apr 13, 2019
@astrofrog astrofrog marked this pull request as ready for review April 13, 2019 18:17
@codecov
Copy link

codecov bot commented Apr 13, 2019

Codecov Report

Merging #77 into master will decrease coverage by 0.4%.
The diff coverage is 65.45%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #77      +/-   ##
==========================================
- Coverage   92.06%   91.66%   -0.41%     
==========================================
  Files          63       63              
  Lines        2761     2746      -15     
==========================================
- Hits         2542     2517      -25     
- Misses        219      229      +10
Impacted Files Coverage Δ
glue_jupyter/widgets/subset_select_test.py 100% <ø> (ø) ⬆️
glue_jupyter/widgets/subset_mode_test.py 100% <100%> (ø) ⬆️
glue_jupyter/__init__.py 73.07% <100%> (+2.7%) ⬆️
glue_jupyter/app.py 79.66% <62.74%> (-7.71%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 82a5603...7bd220f. Read the comment docs.

If you are interested in using glue-jupyter in Jupyter Lab, you will need to
also install the following extensions manually::

jupyter labextension install @jupyter-widgets/jupyterlab-manager bqplot ipyvolume jupyter-threejs
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the same goes for ipyastroimage, but it's not on npm yet, I can give you maintainer rights.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes and ipymaterialui is also missing from npm. I'm happy to deal with ipyastroimage if you like.

Copy link
Member Author

Choose a reason for hiding this comment

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

In any case, I'll just add these to the list later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add proper index page on RTD
2 participants