Charm++ parallel programming system

[Phil Miller <mille121 AT illinois.edu>]

On Thu, Aug 10, 2017 at 11:07 AM, Groner, Robert <rug262 AT psu.edu> wrote:

Phil,

No problem, and thanks for the response.

You're welcome.

 

I saw the doc directory and a Makefile, so I did what any compiler of code would do.  :)   But you're saying that essentially all of the docs for charm++ are in the online docs and there is no need to build the ones in the source, correct?  There are no "pre-built" docs with the source package, right.  In fact, I can delete the docs dir altogether if I want to, and just rely on the online docs?

The biggest reason I'd see to worry about building the docs from the source instead of using the online copy is if one is using a specific release of Charm++, and wants the docs representing the APIs as they existed and were described in that release. The online docs might describe code changes that appeared after the release one has on hand. They are also sometimes updated to more clearly or extensively explain unchanged code, so there's a tradeoff there.

Ideally, we'd take a snapshot of the documentation as of each release, and provide links to both the release-version docs and the latest.

Thanks for reaching out to us, and we'd be interested in hearing about what you're working on with Charm++!

Phil

 

Thanks again.

Rob Groner

Software Engineer

Institute for CyberScience

The Pennsylvania State University

222E Computer Building

University Park, PA 16802

Phone: 814.867.6074

---

From: unmobile AT gmail.com <unmobile AT gmail.com> on behalf of Phil Miller <mille121 AT illinois.edu>
Sent: Thursday, August 10, 2017 11:56 AM
To: Groner, Robert
Cc: charm AT lists.cs.illinois.edu
Subject: Re: [charm] Problems building the documentation

 

Hi Rob,

Sorry for the trouble with this. We automatically build the documentation for our online version [1] any time its source gets edited. This build happens on a specially configured system in our dev environment, because we've encountered tool version skew issues and other similar hassles, like you've just run into. Making the documentation source and build scripts less dependent on particular versions is on the to-do list, but pretty far down, since we mostly expect users to reference the web copy that we provide. If you're feeling particularly motivated, patches to fix this would of course be most welcome.

Apologies, also, for the slow response to your initial message.

Phil

[1] https://ppl.cs.illinois.edu/help

On Wed, Aug 9, 2017 at 10:19 AM, Groner, Robert <rug262 AT psu.edu> wrote:

Has anyone else ever tried to compile the documentation?



Rob Groner
Software Engineer

Institute for CyberScience
The Pennsylvania State University
222E Computer Building
University Park, PA 16802
Phone: 814.867.6074


________________________________________
From: rug262 AT psu.edu <rug262 AT psu.edu>
Sent: Friday, August 4, 2017 11:58 AM
To: charm AT lists.cs.illinois.edu
Subject: [charm] Problems building the documentation

I am using charm++ v 6.7.1 and trying to build the documentation.  I've
installed latex-html and python-bs4 (they were lacking in my system), but I
get another error now that I don't know how to resolve:


*********** WARNINGS ***********
No implementation found for style `../pplmanual'
No implementation found for style `graphicx'
No implementation found for style `calc'
No implementation found for style `fancyvrb'
No implementation found for style `hyphenat'
No implementation found for style `listings'
No implementation found for style `hyperref'

redefining command \thepart

Substitution of arg to newlabelxx delayed.

There is no author for this document.

Unknown commands: credits version nohyphens hypersetup
Done.
../navmenuGenerator.py manual/index.html > tmp-navmenu.html
Traceback (most recent call last):
  File "../navmenuGenerator.py", line 16, in <module>
    toc = soup.find("ul","ChildLinks").extract()
AttributeError: 'NoneType' object has no attribute 'extract'


Any help is appreciated.

Rob