search

ikarus-project / ikarus

Ikarus is a C++-based library that uses DUNE modules to solve partial differential equations with the finite element method and more.
https://ikarus-project.github.io/
Other
6 stars 3 forks source link

Rework local building of the documentation to VS code #286

Open tarun-mitruka opened 6 months ago

tarun-mitruka commented 6 months ago

Currently, the port forwarding isn't working as expected in Clion and hence the documentation is outdated. Also, the images used on this page is outdated. This has to be fixed and generalized.

Currently, the below mentioned workaround can be used:

  1. Go to services in Clion and open an existing container, which has the repository mounted ( This is done automatically, if you exploit/reuse an existing container provided by Clion
  2. Add the port mappings 8000:8000 to the forwarded ports in Dashboard
  3. go to the build directory and the to the subdirectory docs, (where the mkdocs.yml resides)
  4. Execute mkdocs serve
  5. Open 127.0.0.1:8000 in your browser