Skip to content

Commit b797b63

Browse files
committed
Updated README and removed docs.
1 parent 8a0bf01 commit b797b63

12 files changed

+299
-15324
lines changed

CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

HISTORY.rst

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Release 1.0.0-rc1
2+
=========================================
3+
4+
* Preliminary set of demos, linked to a MyBinder.org binder.

LICENSE

+227
Large diffs are not rendered by default.

README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ already published for their
55
[Highcharts JavaScript library](https://www.highcharts.com/demo).
66

77
## How to Use the Demos
8+
9+
### Using MyBinder.org
10+
The easy way is to launch a MyBinder session using the repository: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/highcharts-for-python/highcharts-for-python-demos/HEAD)
11+
12+
Once the MyBinder launches, you will find yourself in a Jupyter Lab environment within a Docker image. You'll have this full repository available to you, and you can navigate the folders to find the demo you want to run.
13+
14+
You will find that the folders are organized according to the Highcharts for Python library being demonstrated, e.g. ``highcharts-core`` for the **Highcharts Core for Python** library, and ``highcharts-stock`` for the **Highcharts Stock for Python** library, etc. And within each of those folders you will find additional folders organizing the demos by chart type or type of demo.
15+
16+
For example, to see how **Highcharts Core for Python** generates a basic line chart, you can open the Notebook at ``highcharts-core/line-charts/basic-line.ipynb``.
17+
18+
Then just run the Notebook, and you should see the results.
19+
20+
### Using the Demos Locally
21+
To use the demos locally, you need to take several additional steps:
22+
823
First, clone this Github repo:
924

1025
```
@@ -54,4 +69,10 @@ highcharts-for-python-demos/ (master)
5469
$ jupyter-lab
5570
```
5671
57-
You should now see the set of notebooks included in the repo, along with relevant data files and other details. Browse through the repo, and look at the demos that you want to see. It should be fairly self-explanatory!
72+
You should now see the set of notebooks included in the repo, along with relevant data files and other details.
73+
74+
You will find that the folders are organized according to the Highcharts for Python library being demonstrated, e.g. ``highcharts-core`` for the **Highcharts Core for Python** library, and ``highcharts-stock`` for the **Highcharts Stock for Python** library, etc. And within each of those folders you will find additional folders organizing the demos by chart type or type of demo.
75+
76+
For example, to see how **Highcharts Core for Python** generates a basic line chart, you can open the Notebook at ``highcharts-core/line-charts/basic-line.ipynb``.
77+
78+
Then just run the Notebook, and you should see the results.

docs/Makefile

-20
This file was deleted.

0 commit comments

Comments
 (0)