changing documentation configuration and documentation in files

pencil-code · Sep 20, 2021 · f582bb0 · f582bb0
1 parent 6474859
commit f582bb0
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 10 deletions.
diff --git a/doc/readthedocs/conf.py b/doc/readthedocs/conf.py
@@ -155,6 +155,7 @@
 
 
 # -- Options for LaTeX output ------------------------------------------------
+latex_engine = "xelatex"
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
@@ -175,7 +176,14 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, "PCDOC.tex", "PC Documentation", "Illa R. Losada", "manual")
+    (master_doc, "PCDOC.tex", "PC Documentation", "Illa R. Losada", "manual"),
+    (
+        "manuals/quick-guide",
+        "quickGuide.tex",
+        "Quick start guide",
+        "I. R. Losada, M. Lambrechts, E. Cole, P. Bourdin",
+        "manual",
+    ),
 ]
 
 
@@ -232,8 +240,9 @@
 ## Fortran configuration
 fortran_src = [
     "../../src/ascalar.f90",
+    "../../src/geometrical_types.f90",
     #    "../../src/bfield.f90",
-    # "../../src/magnetic.f90",
+    # "../../src/magnetic.f90"
 ]
 fortran_ext = ["f90"]
 
diff --git a/doc/readthedocs/toc/modfortran.rst b/doc/readthedocs/toc/modfortran.rst
@@ -3,4 +3,16 @@
 Fortran module
 **************
 
-Soon!
+Testing...
+
+
+Module ascalar
+--------------
+
+.. f:automodule:: ascalar
+
+
+Module Geometrical Types
+-------------------------
+
+.. f:automodule:: geometrical_types
diff --git a/doc/readthedocs/toc/modpython.rst b/doc/readthedocs/toc/modpython.rst
@@ -9,7 +9,7 @@ Pencil python code documentation
 :mod:`pencil`: Pencil package
 -----------------------------
 
-.. autosummary::
+.. .. autosummary::
    :toctree: ../code/sourcePython
    :template: custom-module-template.rst
    :recursive:

diff --git a/src/ascalar.f90 b/src/ascalar.f90
@@ -1,5 +1,4 @@
-! $Id$
-!
+module Ascalar
 ! This module is used to solve the equation of supersaturation
 ! for either the Smoluchowski approach or the swarm model.
 !
@@ -22,8 +21,7 @@
 ! PENCILS PROVIDED del2ttc
 !
 !***************************************************************
-module Ascalar
-!
+
   use Cdata
   use Cparam
   use Messages
@@ -115,7 +113,9 @@ subroutine register_ascalar()
           "$Id$")
 !
     endsubroutine register_ascalar
+
 !***********************************************************************
+
     subroutine initialize_ascalar(f)
 !
 !  Perform any necessary post-parameter read initialization

diff --git a/src/geometrical_types.f90 b/src/geometrical_types.f90
@@ -25,7 +25,7 @@ module Geometrical_types
 
     real, dimension(3) :: center0
     real :: th0,ph0,r_in0,height0
-    contains
+    !contains
     !  procedure, pass :: precess => my_precess
     !procedure :: torus_rect_unfmt_write
     !procedure :: torus_rect_unfmt_read
@@ -36,7 +36,7 @@ module Geometrical_types
 
   contains
 !
-!***********************************************************************
+!**********************************************************************
     subroutine torus_init(torus)
 
     type(torus_rect) :: torus