Skip to content

Doc fixes #781

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rieder merged 7 commits into from
Aug 7, 2021
Merged

Doc fixes #781

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
15ec262
remove troublesome/no longer existing imports
rieder Jul 16, 2021
92251b6
syntax fix
rieder Jul 16, 2021
e7fb3b0
fix
rieder Jul 16, 2021
09c1116
fix typo
rieder Jul 16, 2021
3843563
update code names/paths
rieder Jul 16, 2021
b12841c
fix sphinx error
rieder Jul 16, 2021
76b0645
expand on requirements
rieder Jul 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,7 @@

if not is_running_in_rtd:
extensions.extend([
'matplotlib.sphinxext.only_directives',
'matplotlib.sphinxext.plot_directive',
'gen_rst',
'gen_gallery',
'rst2pdf.pdfbuilder',
])

Expand Down
2 changes: 1 addition & 1 deletion doc/design/architecture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ prone) and easier to couple with other codes.
}

Model of a community code
~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~

The community codes of every module in all physical domains are modelled using
the same template. The template consists of attributes and wrappers. **Attributes**
Expand Down
2 changes: 1 addition & 1 deletion doc/interactive_tutorial/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ clean:
rm -Rf $(RSTFILES)

%.rst:%.ipynb
$(NBCONVERT) rst "$<"
$(NBCONVERT) --to rst "$<"

%.txt:%.rst
python create_title.py "$<" > "$@"
Expand Down
2 changes: 1 addition & 1 deletion doc/interactive_tutorial/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Once you have installed ipython you can run the notebook with:
:maxdepth: 1

01-Loading_AMUSE
02-Quantities_with_units_
02-Quantities_with_units
03-Generic_units
04-Collections_of_Particles
05-Attributes_and_functions_on_particle_collections
Expand Down
12 changes: 6 additions & 6 deletions doc/reference/available-codes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Stellar Dynamics
~~~~~~~~~~~~~~~~

* BHtree_
* hermite0_
* hermite_
* HiGPUs_
* huayno_
* mercury_
Expand Down Expand Up @@ -200,9 +200,9 @@ example

.. [#bh] Barnes, J. & Hut, P. 1986. *Nature* **324**, 446.

.. _hermite0:
.. _hermite:

hermite0
hermite
--------

Time-symmetric N-body integration module with shared but variable time step
Expand Down Expand Up @@ -255,7 +255,7 @@ Parameters
| | | |output |
+------------------------------------+---------------+---------------+-------------------+

.. automodule:: amuse.community.hermite0.interface
.. automodule:: amuse.community.hermite.interface

.. autoclass:: Hermite

Expand Down Expand Up @@ -311,7 +311,7 @@ module the preferred mode can be selected whith the mode parameter:

.. code-block:: python

>>> from amuse.community.phiGRAPE.interface import PhiGRAPEInterface, PhiGRAPE
>>> from amuse.community.phigrape.interface import PhiGRAPEInterface, PhiGRAPE
>>> instance = PhiGRAPE(PhiGRAPE.NBODY, PhiGRAPEInterface.MODE_GPU)

The default is **MODE_G6LIB**.
Expand Down Expand Up @@ -360,7 +360,7 @@ The default is **MODE_G6LIB**.
| | | | |
+------------------------------------+---------------+---------------+-------------------+

.. automodule:: amuse.community.phiGRAPE.interface
.. automodule:: amuse.community.phigrape.interface

.. autoclass:: PhiGRAPE

Expand Down
4 changes: 4 additions & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
matplotlib
pandoc
rst2pdf
Sphinx>=3.0
sphinx-rtd-theme==0.5.2
2 changes: 1 addition & 1 deletion doc/sphinxext/autodoc_parameters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def add_content(self, more_content, no_docstring=False):
else:
sourcename = 'docstring of %s' % self.fullname

encoding = self.analyzer and self.analyzer.encoding
encoding = self.analyzer # and self.analyzer.encoding
lines = prepare_docstring(force_decode(parameter_documentation, encoding))

for i, line in enumerate(self.process_doc([lines,])):
Expand Down