Skip to content

Commit

Permalink
Added a git version print out in HTML and in the PDF.
Browse files Browse the repository at this point in the history
  • Loading branch information
moorepants committed Jan 24, 2024
1 parent 97eccaf commit 736de1f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
README
======

This repository contains the source for the website `Learn Multibody Dynamics
<https://moorepants.github.io/learn-multibody-dynamics/>`_.
This repository contains the source for the interactive textbook `Learn
Multibody Dynamics <https://moorepants.github.io/learn-multibody-dynamics/>`_.

Authors and Contributors
========================
Expand Down
5 changes: 5 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import os
import subprocess

# Configuration file for the Sphinx documentation builder.
#
Expand All @@ -22,6 +23,10 @@
html_title = project
copyright = '2022-2024, Jason K. Moore'
author = 'Jason K. Moore'
version = '0.2.dev0'
commit_id = subprocess.check_output(['git', 'rev-parse', '--short',
'HEAD']).strip().decode('ascii')
version += '+' + commit_id

# -- General configuration ---------------------------------------------------

Expand Down
22 changes: 16 additions & 6 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,26 @@
Learn Multibody Dynamics
========================

Version: |version|

This online book aims to teach multibody dynamics using interactive code woven
into the text. It follows the organization and methods presented in [Kane1985]_
and can be thought of a retelling of many topics in the book. Each page can be
downloaded as a Python_ script or Jupyter_ Notebook. The book is also
`available in PDF format <learnmultibodydynamics.pdf>`_. This book is used
primarily as a companion resource for TU Delft's `Multibody Dynamics B`_ course
taught by `Jason K. Moore`_ but it is designed to standalone from the course.
primarily as a companion resource for TU Delft's `Multibody Dynamics`_ course
taught by `Jason K. Moore`_ but it is designed to standalone from the course.

.. _Python: https://python.org
.. _Jupyter: https://jupyter.org
.. _Multibody Dynamics B: https://moorepants.github.io/me41055
.. _Multibody Dynamics: https://moorepants.github.io/me41055
.. _Jason K. Moore: https://www.moorepants.info

.. todo:: If you make a section header "Table of Contents" then all the primary
pages become sections instead of chapters in the latex document. But with
the caption set to "Table of Contents" they don't but in HTML there is no
section header in the table of contents for the table of contents.

.. toctree::
:maxdepth: 2
:caption: Table of Contents
Expand Down Expand Up @@ -49,12 +56,16 @@ taught by `Jason K. Moore`_ but it is designed to standalone from the course.
Prior Versions
==============

- `Version 0.1`_: Final version from the 2022 course.
- `Version 0.2`_: Final version after the 2023 course.
- `Version 0.1`_: Final version after the 2022 course.

.. _Version 0.2: https://github.com/moorepants/learn-multibody-dynamics/releases/tag/v0.2
.. _Version 0.1: https://github.com/moorepants/learn-multibody-dynamics/releases/tag/v0.1

Lecture Videos
==============

2023 Lecture Video Playlist
===========================

.. raw:: html

Expand All @@ -74,7 +85,6 @@ Prior Versions
</center>

2022 Lecture Video Playlist
===========================

.. raw:: html

Expand Down

0 comments on commit 736de1f

Please sign in to comment.