Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sources always included, is it possible to customize? #172

Closed
szaghi opened this issue Sep 16, 2016 · 9 comments
Closed

Sources always included, is it possible to customize? #172

szaghi opened this issue Sep 16, 2016 · 9 comments

Comments

@szaghi
Copy link
Member

szaghi commented Sep 16, 2016

Dear Chris,

I am now using FORD also for a project that I am not currently want to make free (at least for a while). This project is done in collaboration with a colleague, thus it is useful for us to publish the doc online. We would like to avoid to insert all the sources (at least for the moment). Is it possible to customize the sources insertion?

Thank you as always!

@zbeekman
Copy link
Member

Sorry if you've already tried this, but an explicit source: false in the project file meta-data doesn't meet your needs?

@cmacmackin
Copy link
Contributor

That only hides the source code for individual subroutines, types, etc.
Source listing would still be shown for whole source files.

On 16/09/16 17:14, Izaak Beekman wrote:

Sorry if you've already tried this, but an explicit |source: false| in
the project file meta-data doesn't meet your needs?


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
https://github.com/cmacmackin/ford/issues/172#issuecomment-247642337,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AHxJPavl5wcpSK2BM8vEAI8H0m2eDqLIks5qqsB8gaJpZM4J_Arq.

Chris MacMackin
cmacmackin.github.io http://cmacmackin.github.io

@szaghi
Copy link
Member Author

szaghi commented Sep 17, 2016

@zbeekman Hi Zaak, thank you for your help, but as Chris said this is nor what I am searching for. I tried, but source listing page is always there. This is the first time that I am developing a non FREE (for the moment) project. I am trying to push my collaborators/boss to use FORD...

Aside, if you have private repositories and you want a CI, I found that "shippable" offers 150 builds/month for private reposititories (unlimited for free ones) with also a coverage analyzer (somehow less powerful than Travis/codecov) but still usefull. If you want to test I can give you a minimal shippable.yml config for GNU gfortran 6.

Cheers.

@cmacmackin
Copy link
Contributor

In terms of your actual request: I have other projects that I need to
work on right now, so I don't have time to provide anything other than
bug-fixes for FORD. This should be a very easy thing for you to
implement and I would be happy to accept a pull request. Your other
option would be to host the HTML on a local network or a
password-protected website.

On 17/09/16 07:21, Stefano Zaghi wrote:

@zbeekman https://github.com/zbeekman Hi Zaak, thank you for your
help, but as Chris said this is nor what I am searching for. I tried,
but source listing page is always there. This is the first time that I
am developing a non FREE (for the moment) project. I am trying to push
my collaborators/boss to use FORD...

Aside, if you have private repositories and you want a CI, I found
that "shippable" offers 150 builds/month for private reposititories
(unlimited for free ones) with also a coverage analyzer (somehow less
powerful than Travis/codecov) but still usefull. If you want to test I
can give you a minimal shippable.yml config for GNU gfortran 6.

Cheers.


You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/cmacmackin/ford/issues/172#issuecomment-247752643,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AHxJPd9yJbxvItareHT9cDBhhoWAIpHxks5qq4bfgaJpZM4J_Arq.

Chris MacMackin
cmacmackin.github.io http://cmacmackin.github.io

@szaghi
Copy link
Member Author

szaghi commented Sep 18, 2016

@cmacmackin Do not worry, mine was just a suggestion. If I will have success I will happy to create a pull request.

Cheers.

@gsal
Copy link

gsal commented Dec 29, 2016

Hi, I just started to use FORD yesterday...very nice!

Regarding this issue, the short answer is: "source: false" in the project file does not seem to make a difference, sources are always published.

Thanks,

@cmacmackin
Copy link
Contributor

As I explained above, this option only hides the fragments of the source on each page for types, procedures, etc. This was added for performance reasons, as the regular expressions used to find the appropriate part of the source file are quite expensive and time-consuming when I test FORD. The option does not hide the copy of source code I provide for each file. I do not have time to implement such an option right now, but if someone provides a pull request then I'll be happy to accept it.

@zbeekman
Copy link
Member

I too would like to see this feature, FWIW.

@cmacmackin
Copy link
Contributor

Added in PR #241.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants