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

document usage of an externally hosted Orca instance #2034

Closed
wants to merge 1 commit into from

Conversation

antoinerg
Copy link
Contributor

This PR adds documentation for the new feature introduced in #1850 and #1915 that enables using an externally running Orca to produce static images.

Please feel free to rephrase/modify the text!

cc @nicolaskruchten

@@ -64,6 +64,19 @@ If you are unable to install conda or npm, you can install orca as a precompiled
```
$ pip install psutil requests
```

##### Externally Hosted Orca + pip
Copy link
Contributor

Choose a reason for hiding this comment

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

why "+ pip" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

why "+ pip" ?

I copied the title style of the other subsections. Would you prefer me to remove it?

P.S. One still needs to install dependencies via pip namely requests and psutil (the requirement for the latter could/should be removed but atm it's mandatory) for this feature to work.

@nicolaskruchten nicolaskruchten changed the base branch from master to doc-prod January 6, 2020 21:11
@nicolaskruchten nicolaskruchten changed the base branch from doc-prod to master January 6, 2020 21:11
@nicolaskruchten
Copy link
Contributor

OK so I actually think this should go in https://plot.ly/python/orca-management/ instead... also, if you could branch off of the doc-prod branch and target that branch with your PR that would get things into the docs faster :) The easiest way to do this is to browse to https://plot.ly/python/orca-management/ and click on the "edit this page in Github" link :)

@antoinerg antoinerg closed this Jan 6, 2020
@antoinerg antoinerg deleted the doc-external-orca branch January 6, 2020 22:05
@antoinerg antoinerg restored the doc-external-orca branch January 6, 2020 22:08
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 this pull request may close these issues.

2 participants