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

Revising sorted collections documentation #667

Closed
oxinabox opened this issue Aug 29, 2020 · 2 comments
Closed

Revising sorted collections documentation #667

oxinabox opened this issue Aug 29, 2020 · 2 comments

Comments

@oxinabox
Copy link
Member

oxinabox commented Aug 29, 2020

Originally posted by @StephenVavasis in #479 (moved here since not directly related to the high level roadmap to 1.0)

I would like to make some small revisions to the documentation for sorted containers (see e.g. #528). I don't know how to do this, i.e., I don't know which file I should edit because I don't understand how the docs are organized and populated. Any pointers would be appreciated.

@oxinabox
Copy link
Member Author

@StephenVavasis Sorted container docs are in https://github.com/JuliaCollections/DataStructures.jl/blob/master/docs/src/sorted_containers.md

The docs are built locally via:

  1. Navigate to the docs directory .cd docs
  2. Start julia with the docs directory set as the active project. julia --project=.
  3. Run ] up (can skip this if already done recently)
  4. Run: include("make.jl")
  5. Files will appear in docs/build/index.html

CI runs something similar, but also deploys them

@eulerkochy eulerkochy changed the title Revising sorted colections documentation Revising sorted collections documentation Aug 31, 2020
@StephenVavasis
Copy link
Contributor

Closed via #787

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

No branches or pull requests

2 participants