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

[FEATURE REQUEST] Update User's Guide for HEMCO 3.0.0 release #36

Closed
msulprizio opened this issue Jun 24, 2020 · 5 comments
Closed

[FEATURE REQUEST] Update User's Guide for HEMCO 3.0.0 release #36

msulprizio opened this issue Jun 24, 2020 · 5 comments
Assignees
Labels
category: Feature Request New feature or request TODO: Documentation Improvements or additions to documentation

Comments

@msulprizio
Copy link
Contributor

The HEMCO User's Guide currently at http:https://wiki.seas.harvard.edu/geos-chem/index.php/The_HEMCO_User's_Guide contains a lot of information on a single page and is outdated in many places. The documentation needs to be updated to reflect the updates in this repository. This should be complete by the HEMCO 3.0.0 release, which will be concurrent with the GEOS-Chem 13.0.0 release.

@stale
Copy link

stale bot commented Mar 19, 2021

This issue has been automatically marked as stale because it has not had recent activity. If there are no updates within 7 days it will be closed. You can add the "never stale" tag to prevent the Stale bot from closing this issue.

@stale stale bot added the stale No recent activity on this issue label Mar 19, 2021
@msulprizio
Copy link
Contributor Author

The HEMCO user's guide has been moved to https://hemco.readthedocs.io/en/latest/. Right now, the basics for getting started are included there. I still plan to add more detailed information there prior to the final 3.0.0 release.

@stale stale bot removed the stale No recent activity on this issue label Mar 19, 2021
@msulprizio msulprizio added this to the 3.0.0 milestone Apr 1, 2021
@msulprizio msulprizio added the category: Feature Request New feature or request label Apr 1, 2021
@msulprizio msulprizio removed this from the 3.0.0 milestone Jul 16, 2021
@jimmielin
Copy link
Collaborator

Hi Melissa,

Thanks so much for working on the documentation. I was looking at the HEMCO documentation at Readthedocs earlier and noticed that it doesn't have a stylesheet like the GCHP documentation. I was wondering if maybe the theme isn't being included? I've tried several browsers and they all display like this:

image

Best,
Haipeng

Copy link
Contributor

We had the same issue on the HEMCO ReadTheDocs page as on the GEOS-Chem ReadTheDocs. RTD now uses Sphinx v4.0.0 which seems to be problematic. The fix is to restrict the version numbers of Sphinx and other Python modules as in commit: 927f625

@yantosca
Copy link
Contributor

We can close out this issue because we now have good stable documentation at https://hemco.readthedocs.io.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: Feature Request New feature or request TODO: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants