Skip to content

some improvements to [shapes.md] #74

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

some improvements to [shapes.md] #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f04db1f
formatting and typos
Mo-Gul Mar 9, 2025
323e15a
fix: use `line()`, `rect()`, `circle()` in `shapes[]`
Mo-Gul Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,29 @@ Documentation for the Plotly Julia graphing library.

## Developer Setup


**Julia setup**

1. Download and install latest Julia from official source: https://julialang.org/downloads/ (at least version 1.6)
2. Start Julia in this repo
3. At Julia prompt press `]` to move REPL into package mode. Prompt should be `(@v1.6) pkg>`
4. At package prompt use command `activate .`. Prompt should now read `(plotlyjs.jl-docs) pkg>`
5. Install necessary Julia packages by entering `instantiate` command at package prompt
1. Download and install latest Julia from official source: https://julialang.org/downloads/ (at least version 1.6).
2. Start Julia in this repo.
3. At Julia prompt press `]` to move REPL into package mode.
Prompt should be `(@v1.6) pkg>`.
4. At package prompt use command `activate .`.
Prompt should now read `(plotlyjs.jl-docs) pkg>`.
5. Install necessary Julia packages by entering `instantiate` command at package prompt.

## Building docs

After completing installation steps above, you should be able to build the docs by running `make` or `make html`

Note that `make` will process only modified markdown files from the `julia` directory. This will be done in a separate Julia process for each file
After completing installation steps above, you should be able to build the docs by running `make` or `make html`.

The `make html` will process ALL markdown files in the `julia` directory (even those that have not been modified) in a single Julia process with multiple threads. If you need to do a clean build of the docs the `make html` rule will be more efficient
Note that `make` will process only modified markdown files from the `julia` directory.
This will be done in a separate Julia process for each file.

The `make html` will process ALL markdown files in the `julia` directory (even those that have not been modified) in a single Julia process with multiple threads.
If you need to do a clean build of the docs the `make html` rule will be more efficient.

### Building from Julia

When working on many doc pages, it can greatly reduce Julia compiler times and overall latency to keep a Julia session runing while building.
When working on many doc pages, it can greatly reduce Julia compiler times and overall latency to keep a Julia session running while building.

One common workflow would be to iteratively test if a single file can be build.

Expand All @@ -44,4 +46,5 @@ include("make.jl")
process_file("my-file.md")
```

This will cause just the only file `julia/my-file.md` to be built. If, after making some changes, you want to build again run the `process_file("my-file.md")` command again.
This will cause just the only file `julia/my-file.md` to be built.
If, after making some changes, you want to build again run the `process_file("my-file.md")` command again.
Loading