Skip to content

Commit

Permalink
Updates doc source files.
Browse files Browse the repository at this point in the history
  • Loading branch information
luizfelippesr committed Oct 26, 2020
1 parent adfd794 commit f32f7bc
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 83 deletions.
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

# General information about the project.
project = u'GalMag'
copyright = u'2017, Luiz Felippe S. Rodrigues'
copyright = u'2020, Luiz Felippe S. Rodrigues'
author = u'Luiz Felippe S. Rodrigues'

# The version info for the project you're documenting, acts as replacement for
Expand Down
41 changes: 20 additions & 21 deletions doc/galmag.B_generators.rst
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
galmag.B_generators package
===========================
galmag.B\_generators package
============================

Submodules
----------

galmag.B_generators.B_generator module
--------------------------------------
galmag.B\_generators.B\_generator module
----------------------------------------

.. automodule:: galmag.B_generators.B_generator
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.B_generators.B_generator_disk module
-------------------------------------------
galmag.B\_generators.B\_generator\_disk module
----------------------------------------------

.. automodule:: galmag.B_generators.B_generator_disk
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.B_generators.B_generator_halo module
-------------------------------------------
galmag.B\_generators.B\_generator\_halo module
----------------------------------------------

.. automodule:: galmag.B_generators.B_generator_halo
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: galmag.B_generators
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
13 changes: 6 additions & 7 deletions doc/galmag.analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ galmag.analysis.visualization module
------------------------------------

.. automodule:: galmag.analysis.visualization
:members:
:undoc-members:
:show-inheritance:

:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: galmag.analysis
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:
102 changes: 51 additions & 51 deletions doc/galmag.rst
Original file line number Diff line number Diff line change
@@ -1,102 +1,102 @@
galmag package
==============

Module contents
---------------

.. automodule:: galmag
:members:
:undoc-members:
:show-inheritance:


Subpackages
-----------

.. toctree::
:maxdepth: 4

galmag.B_generators
galmag.analysis
galmag.B_generators
galmag.analysis

Submodules
----------

galmag.B_field module
---------------------
galmag.B\_field module
----------------------

.. automodule:: galmag.B_field
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.Grid module
------------------

.. automodule:: galmag.Grid
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.Observables module
-------------------------

.. automodule:: galmag.Observables
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.disk_profiles module
---------------------------
galmag.disk\_profiles module
----------------------------

.. automodule:: galmag.disk_profiles
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.electron_profiles module
-------------------------------
galmag.electron\_profiles module
--------------------------------

.. automodule:: galmag.electron_profiles
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.galerkin module
----------------------

.. automodule:: galmag.galerkin
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.halo_free_decay_modes module
-----------------------------------
galmag.halo\_free\_decay\_modes module
--------------------------------------

.. automodule:: galmag.halo_free_decay_modes
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.halo_profiles module
---------------------------
galmag.halo\_profiles module
----------------------------

.. automodule:: galmag.halo_profiles
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.util module
------------------

.. automodule:: galmag.util
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

galmag.version module
---------------------

.. automodule:: galmag.version
:members:
:undoc-members:
:show-inheritance:
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: galmag
:members:
:undoc-members:
:show-inheritance:
5 changes: 2 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,8 @@ def read(fname):

setup(name="galmag",
version=__version__,
author="Luiz Felippe S. Rodrigues <luiz.rodrigues@newcastle.ac.uk>, "
"Theo Steininger <theos@mpa-garching.mpg.de>",
author_email="luiz.rodrigues@newcastle.ac.uk",
author="Luiz Felippe S. Rodrigues <luizfelippesr@alumni.usp.br>"
author_email="luizfelippesr@alumni.usp.br",
keywords = "magnetic field, galaxy, Galaxy",
description= ("Generates realistic galactic magnetic field based on the "
"dynamo equation"),
Expand Down

0 comments on commit f32f7bc

Please sign in to comment.