Skip to content

Commit

Permalink
[doc] documentation update, see further notes (#238)
Browse files Browse the repository at this point in the history
removed python2 installation and development descriptions, added pdf output to makefile, updated doc contributors list, removed collapsed code and fixed old hyperlinks
  • Loading branch information
MitchiLaser committed Oct 9, 2023
1 parent 9906587 commit 3932811
Show file tree
Hide file tree
Showing 6 changed files with 112 additions and 247 deletions.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ devenv:

docs: devenv
echo "Generating Docs"
. venv/bin/activate; cd doc && $(MAKE) html
. venv/bin/activate; \
cd doc; \
$(MAKE) html; \
$(MAKE) latex;

publish: build
echo "uploading build to PyPI"
Expand Down
2 changes: 1 addition & 1 deletion doc/src/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div id="impressum" style="text-align: justify;">
<h3>Project Info and Contact</h3>
<p style="font-size: 90%">
This project originated at the <a href="http://www.ekp.kit.edu/english/index.php">Institute of Experimental Nuclear Physics</a> (IENP) at the <a href="http://www.kit.edu/english/index.php">Karlsruhe Insitute of Technology</a> (KIT). The software was developed as part of a Bachelor's Thesis in Physics.
This project originated at the <a href="http://www.ekp.kit.edu/english/index.php">Institute of Experimental Particle Physics (ETP)</a> at the <a href="http://www.kit.edu/english/index.php">Karlsruhe Insitute of Technology</a> (KIT). The software was developed as part of a Bachelor's Thesis in Physics.
</p>
<p style="font-size: 90%">
The author may be contacted at:
Expand Down
8 changes: 4 additions & 4 deletions doc/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def setup(app):

# General information about the project.
project = u'kafe2'
copyright = f'2019-{datetime.now().year}, J. Gäßler, C. Verstege, D. Savoiu and G. Quast'
copyright = f'2019-{datetime.now().year}, J. Gäßler, C. Verstege, D. Savoiu, M. Hohenstein and G. Quast'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -310,7 +310,7 @@ def setup(app):
# author, documentclass [howto, manual, or own class], toctree_only).
latex_documents = [
('index', 'kafe2.tex', u'kafe2 Documentation',
u'J. Gäßler, C. Verstege, D. Savoiu, G. Quast', 'manual', False),
u'J. Gäßler, C. Verstege, D. Savoiu, M. Hohenstein, G. Quast', 'manual', False),
]

# The name of an image file (relative to this directory) to place at the top of
Expand Down Expand Up @@ -340,7 +340,7 @@ def setup(app):
# (source start file, name, description, authors, manual section).
man_pages = [
('kafe2', 'kafe2', u'kafe2 Documentation',
[u'D. Savoiu, G. Quast'], 1)
[u'J. Gäßler, C. Verstege, D. Savoiu, M. Hohenstein, G. Quast'], 1)
]

# If true, show URL addresses after external links.
Expand All @@ -354,7 +354,7 @@ def setup(app):
# dir menu entry, description, category)
texinfo_documents = [
('kafe2', 'kafe2', u'kafe2 Documentation',
u'J. Gäßler, C. Verstege, D. Savoiu, G. Quast', 'kafe2', 'One line description of project.',
u'J. Gäßler, C. Verstege, D. Savoiu, M. Hohenstein, G. Quast', 'kafe2', 'One line description of project.',
'Miscellaneous'),
]

Expand Down

0 comments on commit 3932811

Please sign in to comment.