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

got doxygen build working #77

Merged
merged 3 commits into from
Mar 7, 2018

Conversation

edhartnett
Copy link
Contributor

Part of #75.

Minor changes to get doxygen build working with existing .md files.

This produces pretty decent documentation. @WardF I suggest you build it and put it up on the website while I work on the rest of the docs. It's very important for HPC users to have fortan docs. They do not use the C library - they use fortran.

@WardF
Copy link
Member

WardF commented Feb 1, 2018

3,646 files changed?

@edhartnett
Copy link
Contributor Author

Stand by I will take a look...

@zerothi
Copy link
Contributor

zerothi commented Feb 1, 2018

May I suggest to put the documentation in a separate branch? There is no need for the source code to ship all documentation files (very large source files).

Typically other projects have a gh-pages branch which can equally serve as a hosting service (may be wanted, or not).

@WardF
Copy link
Member

WardF commented Feb 1, 2018

@zerothi My assumption is that the generated files were added accidentally; typically we won’t store generated files under version control because the means to generate them on demand are available.

@zerothi
Copy link
Contributor

zerothi commented Feb 1, 2018

Ok, sorry for the blurp then ;)

@WardF
Copy link
Member

WardF commented Feb 1, 2018

No problem :)

@edhartnett
Copy link
Contributor Author

Yes my fault. I inadvertently checked in all the generated files. Of course that should not be done! ;-)

I have reverted that and now there is just one file changed.

Turns out there is a way to get github to show the generated documentation. It's described here:
https://pages.github.com/

I did this for netcdf-fortran. The output can be seen here:
https://hpc-netcdf.github.io/

@WardF WardF merged commit bdfc31c into Unidata:master Mar 7, 2018
@edhartnett edhartnett deleted the ejh_docs_1 branch March 16, 2019 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants