search

Crompulence / cpl-library

http://www.cpl-library.org
Other
24 stars 9 forks source link

Folder Clean Up #8

Closed edwardsmith999 closed 8 years ago

edwardsmith999 commented 8 years ago

I propose we rearrange the folder system as follows

cpl-library ---|---> docs ------|---> sphinx_doc ------|---> cpl-library website ---|---> src ------|---> obj ------|---> include ---|---> lib ---|---> examples ---|---> make ---|---> tests

Where we have moved cpl/doc_sphinx to doc moved cpl/src/bindings/python/examples to examples cpl is renamed to src demo is renamed to examples

The api reference can then be automatically generated from the latest code (sphinx) while the code examples for the website can be generated with something like highlight (http://www.gnu.org/software/src-highlite/)

What do you think?

edu159 commented 8 years ago

Yes! I agree that is a good rearrangement. I would just merge docs and sphinx_doc into a single folder "doc" and rename "tests" to "test" to follow the common naming convention one usually finds in open-source projects.

Edu

On Tue, 2016-05-31 at 06:52 -0700, Ed Smith wrote:

I propose we rearrange the folder system as follows

cpl-library |---> docs |---> sphinx_doc |---> cpl-library website |---> src |---> examples |---> make |---> tests

Where we have moved cpl/doc_sphinx to doc moved cpl/src/bindings/python/examples to examples cpl is renamed to src demo is renamed to examples

The api reference can then be automatically generated from the latest code (sphinx) while the code examples for the website can be generated with something like highlight (http://www.gnu.org/software/src-highlite/)

What do you think?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

edwardsmith999 commented 8 years ago

Looks very good +tests working :) Should I close this?

edu159 commented 8 years ago

Yes, I think so. I cut down the examples so CFD send and MD receives as the intention was to be a minimal example. Also I removed the array_stuff module. It can be recovered if needed! What do you think?

edwardsmith999 commented 8 years ago

No, sounds good, minimal should be as minimal as possible. Are the example permutations part of the tests for the various combinations of language? When these work as part of the testing framework then we are ready to release i think. I'll add topology design tool, a sine send example and md/CFD minimal examples soon.

I see the website is also on the repo, did you clone this and change the pointer on the web server so it's the latest git version? We could set to regenerate docs using a git hook & setup a chron tab on the server to pull every day so we never need to adapt the website on the server directly. Is this sensible?

From: edu159 notifications@github.com Sent: 03 June 2016 17:54:45 To: Crompulence/cpl-library Cc: Smith, Edward R; Author Subject: Re: [Crompulence/cpl-library] Folder Clean Up (#8)

Yes, I think so. I cut down the examples so CFD send and MD receives as the intention was to be a minimal example. Also I removed the array_stuff module. It can be recovered if needed! What do you think?

You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/Crompulence/cpl-library/issues/8#issuecomment-223633155, or mute the threadhttps://github.com/notifications/unsubscribe/AMv10XrNrNhHFstynCHGC9ZaNQ8z0ce0ks5qIFxVgaJpZM4Iqjda.