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.

Sign up for GitHub

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

Jump to bottom

Readthedocs hotfix #108

Merged
merged 16 commits into from
Dec 9, 2022
Merged

Readthedocs hotfix #108

merged 16 commits into from
Dec 9, 2022

Conversation

aburrell
Copy link
Owner

@aburrell aburrell commented Dec 9, 2022

Description

Fixes broken docs, since meson doesn't allow an install work-around for not having a fortran compiler.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

How Has This Been Tested?

Building docs locally without apexpy installed.

Checklist

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to Changelog.rst, summarising the changes
  • Add yourself to AUTHORS.rst and .zenodo.json

aburrell and others added 16 commits December 9, 2022 09:22
@aburrell
Merge pull request #105 from aburrell/doc_bugfix
063c5ad 
DOC: fix broken links
@aburrell
BUG: no fortran on readthedocs
8619b79 
The lack of fortran on readthedocs is again causing issues (just sooner now).  Trying mock imports to fix this.
@aburrell
BUG: remove apexpy install
56091dd 
Remove the apexpy install from the doc requirements.
@aburrell
TST: more mock updates
d63b1c4 
More mock update attempts.
@aburrell
TST: try autoapi
007be5d 
Trying autoapi to get the API to work without installing apexpy.
@aburrell
TST: adapt meson
5da927b 
Adapt meson to skip fortran for readthedocs.
@aburrell
BUG: updated os
8a73270 
Updated the RTD os.
@aburrell
BUG: missing path
08b1a69 
The path key is required.
@aburrell
BUG: fix env variable
ef6e2d7 
Fix the env variable definition.
@aburrell
REV: revert meson build
d0d7070 
Revert special meson build for RTD.
@aburrell
TST: new attempt at autoapi
88811e5 
Another attempt at using autoapi.
@aburrell
BUG: added output dir
d22fb7d 
Added an output directory for autodoc.
@aburrell
BUG: updated makefile
302ad60 
Updated the directory of the project in the makefile.
@aburrell
DOC: updated conf to use autoapi
625da57 
Updated the conf to use autoapi correctly.
@aburrell
DOC: updated API references
94bbeca 
Restructured the API references for the autoapi format.
@aburrell
MAINT: updated the .gitignore
5ff7766 
Updated .gitignore to reflect the changes in the docs.
@aburrell aburrell merged commit 2dff2dc into develop Dec 9, 2022
@aburrell aburrell deleted the readthedocs_hotfix branch December 9, 2022 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@aburrell