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

New docs using Sphinx + Breathe #568

Merged
merged 11 commits into from
May 20, 2021

Conversation

ghutchis
Copy link
Member

@ghutchis ghutchis commented May 9, 2021

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
@ghutchis
Copy link
Member Author

ghutchis commented May 9, 2021

I'm not 100% sure .. the Breathe package requires some manual work to get the API Doxygen bits up, but I like the general approach:

  • Move to "edit this page" links
  • Highlight script documentation (e.g., make it super-easy)
  • Migrate off MediaWiki

I'll throw up a demo site soon.

Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
@ghutchis
Copy link
Member Author

ghutchis commented May 14, 2021

Almost done.. I think a few missing pages for the initial release:

  • splash gallery
  • install
    • releases
    • nightly builds
    • build from source
  • contribute
  • roadmap

Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
@github-actions
Copy link
Contributor

Here are the build results
macOS.dmg
Ubuntu1804.tar.gz
Ubuntu2004.tar.gz
Win64.exe
Artifacts will only be retained for 90 days.

Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
@github-actions
Copy link
Contributor

Here are the build results
macOS.dmg
Ubuntu1804.tar.gz
Ubuntu2004.tar.gz
Win64.exe
Artifacts will only be retained for 90 days.

Signed-off-by: Geoff Hutchison <geoff.hutchison@gmail.com>
@ghutchis ghutchis merged commit df0135f into OpenChemistry:master May 20, 2021
@ghutchis ghutchis deleted the sphinx-breathe-docs branch May 20, 2021 20:29
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.

None yet

1 participant