More docs unification #79
Conversation
Codecov Report
@@ Coverage Diff @@
## master #79 +/- ##
======================================
Coverage 0.00% 0.00%
======================================
Files 8 8
Lines 466 466
======================================
Misses 466 466 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
docs/pages.jl
Outdated
| @@ -1,7 +1,7 @@ | |||
| # Put in a separate page so it can be used by SciMLDocs.jl | |||
|
|
|||
| pages = [ | |||
| "Home" => "index.md", | |||
| "Overview" => "index.md", | |||
There was a problem hiding this comment.
We do need some kind of tag line.
Otherwise it won't do well in search. This doesn't necessarily need to be the label in the SciMLDocs.
There was a problem hiding this comment.
I don't immediately see a way for the two to be separated?
The <title> element of https://nonlinearsolve.sciml.ai/ seems to be "first item on dropdown menu · NonLinearSolve.jl"
where NonLinearSolve.jl is what is used as the sitename keyword argument in the makedocs function.
There was a problem hiding this comment.
We can make a bool that is set before pages.jl is loaded that then allowed for is_scimldocs and to switch whether to place the title on or not.
But I would greatly prefer just always having the title so it shows up on search engines, and making an issue to Documenter.jl to decouple the sidebar name from the title.
There was a problem hiding this comment.
You can give a different sidebar name using that technique, but you still have to fill in something for the sidebar for is_scimldocs=false.
Currently for DifferentialEquations.jl it is
<title>DifferentialEquations.jl: Scientific Machine Learning (SciML) Enabled Simulation and Estimation · DifferentialEquations.jl</title>Which has DifferentialEquations in there twice, once from the a name in the dropdown menu and once from the sitename keyword argument.
So you could make the sitename argument an empty string. But then if you go to down the dropdown menu e.g
<title>Solving Large Stiff Equations · DifferentialEquations.jl</title>It would also lose the DifferentialEquations, which is not great if somebody is searching for: "stiff equations DifferentialEquations.jl".
I'll make an issue with Documenter.jl .
|
The way it is done now should give: <title>NonlinearSolve.jl: High-Performance Unified Nonlinear Solvers · SciML</title> which is in my opinion the prettiest option given Documenter's current limitations. Dropdown menu to be fixed later. |
No description provided.