Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.41 KB

about_docs.md

File metadata and controls

68 lines (43 loc) · 2.41 KB

ONSAS Documentation

Steps to edit the documentation

Install Julia

  1. In ubuntu, at the terminal you should run:
$ sudo apt-get install julia

Install dependencies

  1. open a Julia session and install the dependencies:
julia> ]

(@v1.5) pkg>

(@v1.5) pkg> add Documenter

(@v1.5) pkg> add Plots

(@v1.5) pkg> add LaTeXStrings

Edit, preview and publish

  1. Clone the repo from the bash terminal:
$ git clone https://github.com/ONSAS/ONSAS_docs.git

  1. Create or checkout to your branch and Edit the documents.

  2. Create the documentation using make.jl. For that from your ONSASdocs folder, run:

$ julia docs/make.jl

In Windows from a Julia session:

julia> include(".\\docs\\make.jl")

The documentation is generated in the folder docs/build. Open the file index.html to visualize the result.

  1. Commit the changes and crete the Pull Request to master.

Dependencies to compile PDF

  • lualatex
  • python-pygments
  • minted (en texlive/extras)

Crear o editar tutoriales

Los tutoriales se encuentran en la carpeta https://github.com/ONSAS/ONSAS-doc/tree/master/tutorials.

  • Para editar un tutorial existente, ubicar el archivo que contiene el tutorial, por ejemplo linear_elastic.jl y editarlo directamente.

  • Para crear un tutorial nuevo, generar un archivo .jl en una nueva carpeta o una carpeta existente bajo tutorials. Luego asegurarse que el archivo se lee en generate.jl, que es el script encargado de transforma el archivo fuente .jl a un documento .md que muestra la web html. Por último, editar el argumento pages dentro de makedocs aqui, de forma que se incorpore el nuevo tutorial al panel de navegación de la documentación online.

El formato .jl es un archivo de Julia, con comandos adicionales que interpreta el paquete Literate. Por más información y opciones de formato, ver la documentacion de Literate.jl.

Editar bibliografía

Para editar la bibliografía publicada, se debe modificar el archivo biblio.bib. Al realizar la compilación con el comando make.jl se reescribirán los archivos _biblio.bib y references.md.