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

Add refs to IEEE-P1076.gitlab.io through intersphinx #32

Merged
merged 2 commits into from Sep 28, 2021

Conversation

umarcor
Copy link
Member

@umarcor umarcor commented Sep 27, 2021

I'm trying to add references to IEEE-P1076.gitlab.io through intersphinx, with no success. This PR is for showcasing the issue, in the hope that someone can help me understand what's going on.

This is the output I get:

image

  • Using role label, the targets are not correct.
  • Using ref without the VASG namespace is correct, however, it does not work if the namespace is specified.
  • Using doc works regardless of the namespace being used.

My understanding is that this might be a bug in Sphinx/Intersphinx.

@Paebbels
Copy link
Member

My understanding is that this might be a bug in Sphinx/Intersphinx.

@umarcor are you going to file a bug report?

We're using latest Sphinx v4.2.x, right?

@Paebbels Paebbels added the documentation Improvements or additions to documentation label Sep 27, 2021
@Paebbels Paebbels changed the title Add refs to IEEE-P1076.gitlab.io through interpshinx Add refs to IEEE-P1076.gitlab.io through intersphinx Sep 27, 2021
@umarcor
Copy link
Member Author

umarcor commented Sep 27, 2021

@umarcor are you going to file a bug report?

We're using latest Sphinx v4.2.x, right?

@Paebbels, yes we are using latex Sphinx: https://github.com/VHDL/pyVHDLModel/runs/3715512683?check_suite_focus=true#step:5:173.

Before opening a bug report, I would like to understand why references to python or OSVB namespaces do work, but not for pyVHDLModel or pySystemVerilogModel.

@github-actions
Copy link

Unit Test Results (Python 3.8)

  1 files  ±0    1 suites  ±0   0s ⏱️ ±0s
14 tests ±0  14 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit e033eaa. ± Comparison against base commit f495a6f.

@github-actions
Copy link

Unit Test Results (Python 3.7)

  1 files  ±0    1 suites  ±0   0s ⏱️ ±0s
14 tests ±0  14 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit e033eaa. ± Comparison against base commit f495a6f.

@github-actions
Copy link

Unit Test Results (Python 3.9)

  1 files  ±0    1 suites  ±0   0s ⏱️ ±0s
14 tests ±0  14 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit e033eaa. ± Comparison against base commit f495a6f.

@github-actions
Copy link

Unit Test Results (Python 3.6)

  1 files  ±0    1 suites  ±0   0s ⏱️ ±0s
14 tests ±0  14 ✔️ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit e033eaa. ± Comparison against base commit f495a6f.

@umarcor umarcor marked this pull request as ready for review September 27, 2021 21:59
@umarcor
Copy link
Member Author

umarcor commented Sep 27, 2021

As explained in sphinx-doc/sphinx#9682 (comment), the intersphinx mapping identifier needs to be lowercase. I fixed this PR, and it is now ready to merge.

@codecov
Copy link

codecov bot commented Sep 27, 2021

Codecov Report

Merging #32 (e033eaa) into dev (f495a6f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev      #32   +/-   ##
=======================================
  Coverage   74.11%   74.11%           
=======================================
  Files           4        4           
  Lines        2306     2306           
  Branches      352      352           
=======================================
  Hits         1709     1709           
  Misses        584      584           
  Partials       13       13           
Flag Coverage Δ
unittests 74.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


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 f495a6f...e033eaa. Read the comment docs.

@Paebbels Paebbels merged commit 8eb0973 into dev Sep 28, 2021
@Paebbels Paebbels deleted the umarcor/intersphinx-vasg branch September 28, 2021 05:23
@umarcor umarcor added the enhancement New feature or request label Dec 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants