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

LinearAlgebra.BLAS: sort and group blas functions #46035

Merged
merged 8 commits into from
Jul 16, 2022

Conversation

inkydragon
Copy link
Sponsor Member

  • No additions or deletions.
  • stdlib: Sorted exported functions
  • doc: BLAS functions are grouped and sorted
  • Added placeholders for missing BLAS functions

group and sort ref: http:https://www.netlib.org/blas/blasqr.pdf

@inkydragon inkydragon added domain:docs This change adds or pertains to documentation stdlib Julia's standard library labels Jul 14, 2022
@inkydragon inkydragon changed the title [doc/stdlib]: LinearAlgebra.BLAS: sort and group blas functions LinearAlgebra.BLAS: sort and group blas functions Jul 14, 2022
@ViralBShah ViralBShah added the status:merge me PR is reviewed. Merge when all tests are passing label Jul 14, 2022
@ViralBShah
Copy link
Member

Off-topic, but thinking about further refactoring, we do want to move LinearAlgebra into its own repo (but it will still be an stdlib and in the system image).

@inkydragon
Copy link
Sponsor Member Author

we do want to move LinearAlgebra into its own repo

I can't wait.
Now the LinearAlgebra document is very looooong, and we only show the <h2> headings (waiting for right side TOC), which makes this document hard to read.

If LinearAlgebra is split into a separate package, then this looong document can be split into multiple pages, which will better organize the document and improve readability.

@ViralBShah
Copy link
Member

We should split it into multiple pages anyways - can't we already do it now? It will definitely be much easier in a separate repo, where we can move faster.

@KristofferC what do we need to do to move LinearAlgebra to a new repo? I always forget a few steps.

@inkydragon inkydragon removed the status:merge me PR is reviewed. Merge when all tests are passing label Jul 14, 2022
@ViralBShah ViralBShah added domain:linear algebra Linear algebra status:merge me PR is reviewed. Merge when all tests are passing labels Jul 14, 2022
@inkydragon
Copy link
Sponsor Member Author

inkydragon commented Jul 15, 2022

can't we already do it now?

After some trying, I found some hard codes.

julia/doc/make.jl

Lines 27 to 32 in fd70eab

sourcefile = joinpath(STDLIB_DIR, dir, "docs", "src")
if dir in EXT_STDLIB_DOCS
sourcefile = joinpath(sourcefile, "basedocs.md")
else
sourcefile = joinpath(sourcefile, "index.md")
end

It looks like some modifications are needed to support multiple source files.


After more attempts, it looks like it is not possible to generate multi-page documents by directly inserting more md files into the STDLIB_DOCS variable.

image

This also explains why we let the Pkg package, which already has multi-page documents, display only a single-page doc.

const EXT_STDLIB_DOCS = ["Pkg"]

@ViralBShah ViralBShah merged commit 9357792 into JuliaLang:master Jul 16, 2022
@inkydragon inkydragon deleted the doc-blas-sort branch July 16, 2022 12:06
@DilumAluthge DilumAluthge removed the status:merge me PR is reviewed. Merge when all tests are passing label Jul 17, 2022
ffucci pushed a commit to ffucci/julia that referenced this pull request Aug 11, 2022
* stdlib: LinearAlgebra.BLAS: sort and group blas lv1 functions

* stdlib: LinearAlgebra.BLAS: sort and group blas lv2 functions

* stdlib: LinearAlgebra.BLAS: sort and group blas lv3 functions

Co-authored-by: Viral B. Shah <[email protected]>
pcjentsch pushed a commit to pcjentsch/julia that referenced this pull request Aug 18, 2022
* stdlib: LinearAlgebra.BLAS: sort and group blas lv1 functions

* stdlib: LinearAlgebra.BLAS: sort and group blas lv2 functions

* stdlib: LinearAlgebra.BLAS: sort and group blas lv3 functions

Co-authored-by: Viral B. Shah <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation domain:linear algebra Linear algebra stdlib Julia's standard library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants