ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

reduce sphinx warnings

Browse Source
This commit is contained in:
Axel Kohlmeyer
2023-05-04 16:35:49 -04:00
parent 787399f5e3
commit 77ea3ed215
3 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/src/Modify.rst
View File

@ -1,18 +1,22 @@
Modifying & extending LAMMPS
****************************
LAMMPS is designed in a modular fashion and to be easy to modify or
extend with new functionality. In fact, about 95% of its source code
LAMMPS is designed in a modular fashion and easy to be modified or
extended with new functionality. In fact, about 95% of its source code
is optional. The following pages give basic instructions on adding new
features to LAMMPS.
features to LAMMPS. More in-depth explanations and documentation of
individual functions and classes are given in :doc:`Developer`.
If you add a new feature to LAMMPS and think it will be of general
interest to other users, we encourage you to submit it for inclusion in
LAMMPS. This process is explained in the following three pages:
:doc:`how to prepare and submit your code <Modify_contribute>`,
:doc:`requirements for submissions <Modify_requirements>`, and
:doc:`style guidelines <Modify_style>`. A discussion of the various
types of styles in LAMMPS is then provided.
:doc:`style guidelines <Modify_style>`.
A summary description of various types of styles in LAMMPS follows.
A discussion of implementing specific styles from scratch is given
in :doc:`Developer_write`.
.. toctree::

7
doc/src/Modify_requirements.rst
View File

@ -1,7 +1,6 @@
Requirements for contributions to LAMMPS
===========================================================
The following is a summary of the current requirements and
recommendations for including contributed source code or documentation
into the LAMMPS software distribution.
@ -41,6 +40,7 @@ include:
.. _License:
Licensing requirements (strict)
-------------------------------
@ -69,8 +69,8 @@ that use code with a conflicting license can be split into two parts:
Please note, that this split licensed mode may complicate including the
contribution in binary packages.
.. _IntegrationTesting:
.. _IntegrationTesting
Integration testing (strict)
----------------------------
@ -95,7 +95,8 @@ testing tools or scripts or tests themselves. This is rare. If in
doubt, contact the LAMMPS developer that is assigned to the pull request.
.. _Documentation
.. _Documentation:
Documentation (strict)
----------------------

9
doc/src/Modify_style.rst
View File

@ -1,5 +1,5 @@
LAMMPS programming style
===========================================================
========================
The LAMMPS developers aim to employ a consistent programming style and
@ -15,7 +15,7 @@ may serve as representative examples.
Include files (varied)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^
- system headers or from installed libraries are include with angular
brackets (example: ``#include <vector>``), while local include file
@ -141,8 +141,7 @@ Miscellaneous standards (varied)
scripts for interpreted script languages.
Whitespace (preferred)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^
LAMMPS uses 2 characters per indentation level and lines should be
kept within 100 characters wide.
@ -165,7 +164,7 @@ issues.
Placement of braces (strongly preferred)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
On new lines for methods, when to use, etc.