line 49 test.py

[ceyzeriat]

There is an issue in whisky that is revealed at line 49 of test.py, which makes the documentation generation bug (which is why the whisky package is not in the doc)

[benjaminpope]

Pushed new version. Bug appears fixed - but it references Alexey's data, so can you run this on suphys before I close this issue?

[ceyzeriat]

you fixed the bug on master while the doc is on "docs" branch. Sent another mail explaining that all code needed to be moved to sub-dir, "code", to make the docs work in a neat way.
This essentially that everybody's "pythonpath" in bashrc needs to be updated with that sub-dir. That should be it.
Should we merge?

[benjaminpope]

Is that really the most effective way to do things? Given that all the code that needs documentation is in /whisky/ it should have a flag to make this the directory it documents.

---

From: ceyzeriat [notifications@github.com]
Sent: Sunday, November 09, 2014 9:27 AM
To: benjaminpope/whisky
Cc: Benjamin Pope
Subject: Re: [whisky] line 49 test.py (#5)

you fixed the bug on master while the doc is on "docs" branch. Sent another mail explaining that all code needed to be moved to sub-dir, "code", to make the docs work in a neat way.
This essentially that everybody's "pythonpath" in bashrc needs to be updated with that sub-dir. That should be it.
Should we merge?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/5#issuecomment-62297069.

[benjaminpope]

I tend to think that we should exclude top-level scripts from the documentation anyway, as they're ultimately not really for general use. I think the .ipynb format is ultimately what we want the user experience to be, and these are self-documenting.

[ceyzeriat]

"I tend to think that we should exclude top-level scripts from the documentation anyway" Agreed
"Is that really the most effective way to do things?" Dunno if it is the most effective to create that code folder, but that's the only way I know to make the sphinx package work easily. If the pip install setup file are everybody's pythonpath are done accordingly, it shouldn't matter at all.
But if the only file that we want to document are already self-documenting, then we better just remove that sphinx auto-doc.