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 markdown and relative links on github.io page #104

Merged
merged 1 commit into from
May 26, 2021
Merged

Conversation

e-kwsm
Copy link
Contributor

@e-kwsm e-kwsm commented May 26, 2021

README.md has the following relative links:

  • [``dftd4(1)``](man/dftd4.1.adoc)
  • [parameters.toml file](./assets/parameters.toml)
  • [``python``](./python)

These work on GitHub, but do not on https://dftd4.github.io/dftd4/, e.g., https://dftd4.github.io/dftd4/man/dftd4.1.adoc does not exist.

I’m not sure if ford can prefix https://github.com/dftd4/dftd4/blob/main/.

@codecov
Copy link

codecov bot commented May 26, 2021

Codecov Report

Merging #104 (0667abe) into main (750b3ce) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #104   +/-   ##
=======================================
  Coverage   60.01%   60.01%           
=======================================
  Files          39       39           
  Lines        2886     2886           
  Branches      979      979           
=======================================
  Hits         1732     1732           
  Misses        599      599           
  Partials      555      555           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 750b3ce...0667abe. Read the comment docs.

@awvwgk awvwgk added the documentation Related to the documentation of this project label May 26, 2021
Copy link
Member

@awvwgk awvwgk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, that is unfortunate. I don't think ford supports custom prefixes, just adding the prefixes will break the relative links in branches and forks as well as in local previews, but getting the docs to link correctly seems more important.

In the long-term I'll have to look for a new documentation tool anyway, since ford development and maintenance has pretty much stalled.

@awvwgk awvwgk merged commit 2cc90b0 into dftd4:main May 26, 2021
@e-kwsm e-kwsm deleted the readme branch May 27, 2021 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to the documentation of this project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants