search

QEDjl-project / QEDprocesses.jl

[WIP]: QEDprocesses.jl: Modeling of scattering processes for QED.jl
MIT License
1 stars 3 forks source link

Add Differential Cross Section interface, Compton and PerturbativeQED Model #18

Closed AntonReinhard closed 3 months ago

AntonReinhard commented 9 months ago

CI_UNIT_PKG_URL_QEDbase: https://github.com/AntonReinhard/QEDbase.jl#1735e72

AntonReinhard commented 9 months ago

Currently fails because it depends on https://github.com/QEDjl-project/QEDbase.jl/pull/25

SimeonEhrig commented 9 months ago

Currently fails because it depends on QEDjl-project/QEDbase.jl#25

You can run the unit tests with a development branch as dependency: https://github.com/QEDjl-project/QED.jl/blob/dev/docs/src/ci.md#unit-tests-for-ci-users

AntonReinhard commented 7 months ago

The docs building step currently fails because referenced types/functions have moved to QEDbase now, I'm not sure how to proceed with that. I don't want to delete the references or put the links to the QEDbase docs in manually.

Maybe MultiDocumenter would handle this?

SimeonEhrig commented 7 months ago

I don't think it solves the problem. MultiDocumenter compiles only the rendered HTML documentation of different packages.

I found this issue: https://github.com/JuliaDocs/Documenter.jl/issues/688 So it is not official documented.

Maybe we can use as workaround markdown links [foo()](doc.com/api#foo), if we have a API reference page.

AntonReinhard commented 7 months ago

I don't think it solves the problem. MultiDocumenter compiles only the rendered HTML documentation of different packages.

I found this issue: JuliaDocs/Documenter.jl#688 So it is not official documented.

Maybe we can use as workaround markdown links [foo()](doc.com/api#foo), if we have a API reference page.

This would work, but for example AbstractParticle alone is referenced 8 times already, so I'd have to put that link into lots of places... I guess there's not really a better way right now though. Other than not referencing at all.

szabo137 commented 7 months ago

I have another crossref for the docstring issue: https://github.com/JuliaDocs/Documenter.jl/issues/1343

Another workaround would be, to include the docstring of the at_ref function/type to the documentation of QEDprocesses, e.g. in the api.md page. However, this is a bit hacky, because it means to include QEDbase in the makedocs of QEDprocesses (I can provide a showcase or PR if needed). In this case, at_ref works again without specifying the URL, but it seems to be a very ugly solution.

AntonReinhard commented 3 months ago

I'm sorry, I somehow managed to kill this PR by accident. I saved the commits but I might have to open a new PR.