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

tweak formatting and style setting to have the desired structure and layout

Browse Source
This commit is contained in:
Axel Kohlmeyer
2020-09-19 00:54:54 -04:00
parent 6dda562501
commit 9030c987e6
4 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/Makefile
View File

@ -166,14 +166,12 @@ pdf: xmlgen $(VENV) $(SPHINXCONFIG)/conf.py $(ANCHORCHECK)
deactivate ;\
)
@cd latex && \
sed 's/latexmk -pdf -dvi- -ps-/pdflatex/g' Makefile > temp && \
mv temp Makefile && \
sed 's/\\begin{equation}//g' LAMMPS.tex > tmp.tex && \
mv tmp.tex LAMMPS.tex && \
sed 's/\\end{equation}//g' LAMMPS.tex > tmp.tex && \
mv tmp.tex LAMMPS.tex && \
$(MAKE) $(MFLAGS) && \
$(MAKE) $(MFLAGS) && \
sed 's/\\contentsname}{.*}}/\\contentsname}{LAMMPS Documentation}}/g' LAMMPS.tex > tmp.tex && \
mv tmp.tex LAMMPS.tex && \
$(MAKE) $(MFLAGS) && \
mv LAMMPS.pdf ../Manual.pdf && \
cd ../;

20
doc/src/Manual.rst
View File

@ -23,25 +23,28 @@ The content for this manual is part of the LAMMPS distribution. You
can build a local copy of the Manual as HTML pages or a PDF file, by
following the steps on the :doc:`Manual build <Manual_build>` doc page.
The manual is organized in two parts:
1) A :ref:`User documentation <user_documentation>` for how to install
and use LAMMPS and 2) a :ref:`Programmer documentation <programmer_documentation>`
for how to write programs using the LAMMPS library or how to modify LAMMPS.
1) the :ref:`User documentation <user_documentation>` for how to install
and use LAMMPS and 2) the :ref:`Programmer documentation <programmer_documentation>`
for how to write programs using the LAMMPS library from different
programming languages and how to modify and extend LAMMPS.
----------
.. only:: html
Once you are familiar with LAMMPS, you may want to bookmark :doc:`this page <Commands_all>` since it gives quick access to a doc page for
every LAMMPS command.
Once you are familiar with LAMMPS, you may want to bookmark :doc:`this page <Commands_all>` since it gives quick access to a doc page for
every LAMMPS command.
.. _lws: https://lammps.sandia.gov
----------
User Documentation
******************
.. :caption: User Documentation
.. _user_documentation:
.. toctree::
:maxdepth: 2
:numbered: 3
:caption: User Documentation
:name: userdoc
:includehidden:
@ -61,11 +64,12 @@ User Documentation
Programmer Documentation
************************
.. :caption: Programmer Documentation
.. _programmer_documentation:
.. toctree::
:maxdepth: 2
:numbered: 3
:caption: Programmer Documentation
:name: progdoc
:includehidden:

4
doc/utils/sphinx-config/_static/css/lammps.css
View File

@ -27,6 +27,10 @@ hr {
margin-bottom: 12px !important;
}
.section h2 {
display: none;
}
.ui.tabular.menu .item {
padding-right: 1em;
padding-left: 1em;

2
doc/utils/sphinx-config/_themes/lammps_theme/theme.conf
View File

@ -14,5 +14,5 @@ titles_only =
logo_only =
display_version = True
prev_next_buttons_location = both
style_external_links = False
style_external_links = True
style_nav_header_background =