https://github.com/inkydragon/themissingdoc4julia.jl

Exploring how to organize docs better
https://github.com/inkydragon/themissingdoc4julia.jl

Last synced: 9 days ago
JSON representation

Exploring how to organize docs better

• Host: GitHub
• URL: https://github.com/inkydragon/themissingdoc4julia.jl
• Owner: inkydragon
• License: mit
• Created: 2022-10-02T15:55:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-04T14:38:57.000Z (6 months ago)
• Last Synced: 2025-03-14T19:58:27.157Z (4 months ago)
• Language: Julia
• Homepage: https://inkydragon.github.io/TheMissingDoc4Julia.jl
• Size: 1.34 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Missing Doc 4 Julia

[![CI](https://github.com/inkydragon/TheMissingDoc4Julia.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/inkydragon/TheMissingDoc4Julia.jl/actions/workflows/CI.yml)

This project is intended to be a supplement to [the official julia documentation](https://docs.julialang.org/).

When possible, much of the project will be merged into the julia documentation.

This project is a *reference*.

> Reference guides are **technical descriptions** of the machinery and how to operate it.

> Reference material is **information-oriented**.

>

> —— 🔗[Reference - diataxis.fr](https://diataxis.fr/reference/)

## Example

Example doc page:

- [sin - TheMissingDoc4Julia](https://inkydragon.github.io/TheMissingDoc4Julia.jl/dev/ElementaryMath/Trigonometry/Sine/sin/)

See also: [Related Issues](docs/src/index.md)

## Build

1. Clone project.

2. Init and Build:

```sh

julia --project=docs -e "using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate();"

julia --project=docs docs/make.jl

```