peastman / statmech

Introduction to Statistical Mechanics

This is an introductory textbook on statistical mechanics. It is suitable for an undergraduate physics major studying the subject for the first time. The only required prerequisites are multivariable calculus and classical mechanics. You can read it online at https://peastman.github.io/statmech/.

It is written in Sphinx format. To build it as HTML, type

make html

To build it as a PDF, type

make latexpdf

The generated content will be in build/html or build/latex, respectively.

statmech's Issues

make latexpdf works with Python 2, but not Python 3

I am using macOS Big Sur, which comes with Python 2 and Python 3. I pip3 installed the sphinx module, but then make latexpdf fell over with an error as such

sphinx-build -b latex -d build/doctrees   source build/latex
Running Sphinx v3.0.0

Exception occurred:
  File "/Users/tjk/statmech/source/numsec.py", line 50, in setup
    app.override_domain(CustomStandardDomain)
AttributeError: 'Sphinx' object has no attribute 'override_domain'

If I used pip2 to install sphinx, then things work as expected and I get a nice PDF file. Are there any plans to move the documentation generation to Python 3?

Unknown target for autonumber reference:

When I tried to compile the make html file its showing that
Exception occurred:
File "~\statmech-master\source\autonumber.py", line 60, in doctree_resolved
raise ValueError('Unknown target for autonumber reference: '+target)
ValueError: Unknown target for autonumber reference: Figure,binomial

AttributeError: 'Sphinx' object has no attribute 'override_domain'

Exception occurred:
File "/home/miska/repos/statmech/source/numsec.py", line 50, in setup
app.override_domain(CustomStandardDomain)
AttributeError: 'Sphinx' object has no attribute 'override_domain'

works w/:
app.add_domain(CustomStandardDomain, override=True)