chapel-lang / sphinxcontrib-chapeldomain Goto Github PK

Bug Report

Summary of Problem

See chapel-lang/chapel#5190

Sphinx has undergone a change since this domain was originally developed, so it is incompatible with version 1.4.4 and on.

Since most, if not all, uses of this domain are through chpldoc and the virtual environment in which it is built (which pins us to a specific Sphinx version), we view this as a low priority issue and so have not prioritized a fix for it yet

I got the following warning while building the release today:

doc-test run-test: commands[0] | make -C <repo path>/sphinxcontrib-chapeldomain/doc-test html
WARNING: test command found but not installed in testenv
  cmd: /usr/bin/make
  env: <repo path>/sphinxcontrib-chapeldomain/.tox/doc-test
Maybe you forgot to specify a dependency? See also the allowlist_externals envconfig setting.

DEPRECATION WARNING: this will be an error in tox 4 and above!

We should update the script to avoid this error (I just don't want to do it right now)

util/release.bash includes the lines:

echo "Pushing tags to chapel-lang remote..."
git push https://github.com/chapel-lang/sphinxcontrib-chapeldomain --tags

This triggered an email from Github to me about using my password to push to github because the https: form will always using passwords and that support will be deprecated by August 2021. However, we can't guarantee the name used by the particular remote that corresponds to the chapel-lang repo - it could be origin, it could be chapel, it could be chapel-lang, etc.

There's probably a way to compute it by searching the remotes defined for one with the right address. I'm also open to other ideas.

I'm trying to get a Framework :: Sphinx :: Domain PyPi classifier approved to help with the Sphinx docs as well as keep the ecosystem more organize and I need to demonstrate interest by having 10 or more project maintainers submit comments about their desire to use the new classifier.

If the maintainer of this project thinks a Framework :: Sphinx :: Domain would be useful for helping people find the domain as well as help the greater Sphinx ecosystem, please leave a comment on sphinx-doc/sphinx#11562 expressing interest in using the classifier with a link to the package that you maintain to help with the approval process.

Once it gets approved I can come back and submit a PR to add it to the package metadata.

Thanks!

For instance, when I did a brief check through the docs, I saw a reference to IO.channel, which has been replaced. There may be other examples using symbols that no longer exist