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

[FIX-21] building docs locally #23

Merged
merged 4 commits into from
Sep 28, 2023
Merged

Conversation

szabo137
Copy link
Member

Resolves #21.

Applied changes

  • Removed sorting argument from CitationsBibliography
  • Adjusted syntax of the latest version of makedocs using the plugin keyword
  • Fixed typo in docstrings
  • Removed docstring of the QEDbase module (this feature might be broken)
  • Added QEDbase as a dependency to docs

@szabo137 szabo137 added the 07 - Documentation Improvements or additions to documentation label Sep 28, 2023
@SimeonEhrig
Copy link
Member

Why there are a make.jl and make_local.jl. Looks like the make.jl is not working standalone.

@SimeonEhrig
Copy link
Member

Please use an "absolute" path here:

Pkg.develop(; path=".")

project_path = Base.Filesystem.joinpath(Base.Filesystem.dirname(Base.source_path()), "..")

@szabo137
Copy link
Member Author

szabo137 commented Sep 28, 2023

Why there are a make.jl and make_local.jl. Looks like the make.jl is not working standalone.

Oh, this is some ancient leftover. 0945480 removes that.

@SimeonEhrig
Copy link
Member

Looks good. The documentation builds and didn't saw anything strange in the rendered documentation.

@SimeonEhrig SimeonEhrig merged commit e0fa932 into QEDjl-project:dev Sep 28, 2023
@SimeonEhrig SimeonEhrig added this to the 0.1.5 milestone Oct 18, 2023
szabo137 added a commit that referenced this pull request Jan 28, 2024
Resolves #21.

* Removed `sorting` argument from `CitationsBibliography`
* Adjusted syntax of the latest version of `makedocs` using the `plugin`
keyword
* Fixed typo in docstrings
* Removed docstring of the `QEDbase` module (this feature might be
broken)
* Added `QEDbase` as a dependency to docs

---------

Co-authored-by: Uwe Hernandez Acosta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
07 - Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

repair local doc build
2 participants