Fix issues with getting the package name

* Able to get package/root directory paths for general linkcode_resolve function, using the info dict provided
* For TDKMethLexer, not sure how to do the same
    - Takes from conf.py for now.... so that must be set to use this

Author: TDKorn

README.rst

@@ -3,7 +3,7 @@
 ..  Author: TDKorn (Adam Korn)
 
 .. |.get_linkcode_resolve| replace:: ``get_linkcode_resolve()``
-.. _.get_linkcode_resolve: https://github.com/TDKorn/sphinx-github-style/blob/v1.0.0/sphinx_github_style/__init__.py#L150-L207
+.. _.get_linkcode_resolve: https://github.com/TDKorn/sphinx-github-style/blob/v1.0.0/sphinx_github_style/__init__.py#L153-L210
 .. |.add_linkcode_node_class| replace:: ``add_linkcode_node_class()``
 .. _.add_linkcode_node_class: https://github.com/TDKorn/sphinx-github-style/blob/v1.0.0/sphinx_github_style/add_linkcode_class.py#L9-L24
 .. |.TDKStyle| replace:: ``TDKStyle``
@@ -142,6 +142,16 @@ Configuration Variables
 
 Add any of the following configuration variables to your ``conf.py``
 
+``pkg_name``
+^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+   pkg_name: str
+
+
+The name of the top-level package. For this repo, it would be ``sphinx_github_style``
+
 ``linkcode_blob``
 ^^^^^^^^^^^^^^^^^^^
 

README_PyPi.rst

@@ -3,7 +3,7 @@
 ..  Author: TDKorn (Adam Korn)
 
 .. |.get_linkcode_resolve| replace:: get_linkcode_resolve()
-.. _.get_linkcode_resolve: https://github.com/TDKorn/sphinx-github-style/blob/v1.0.0/sphinx_github_style/__init__.py#L150-L207
+.. _.get_linkcode_resolve: https://github.com/TDKorn/sphinx-github-style/blob/v1.0.0/sphinx_github_style/__init__.py#L153-L210
 .. |.add_linkcode_node_class| replace:: add_linkcode_node_class()
 .. _.add_linkcode_node_class: https://github.com/TDKorn/sphinx-github-style/blob/v1.0.0/sphinx_github_style/add_linkcode_class.py#L9-L24
 .. |.TDKStyle| replace:: TDKStyle
@@ -132,6 +132,17 @@ Configuration Variables
 
 Add any of the following configuration variables to your ``conf.py``
 
+``pkg_name``
+^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+   pkg_name: str
+
+
+The name of the top-level package. For this repo, it would be ``sphinx_github_style``
+
+
 ``linkcode_blob``
 ^^^^^^^^^^^^^^^^^^^
 

docs/source/README.rst

@@ -117,6 +117,17 @@ Configuration Variables
 
 Add any of the following configuration variables to your ``conf.py``
 
+``pkg_name``
+^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: python
+
+   pkg_name: str
+
+
+The name of the top-level package. For this repo, it would be ``sphinx_github_style``
+
+
 ``linkcode_blob``
 ^^^^^^^^^^^^^^^^^^^
 

docs/source/conf.py

@@ -23,8 +23,6 @@
 
 # Configure paths
 root = os.path.abspath('../../')
-modpath = root
-
 sys.path.append(os.path.abspath('.'))
 sys.path.insert(0, root)
 
@@ -39,12 +37,11 @@
 repo = project
 
 # Package Info
-modname = os.path.basename(modpath)
-pkg = pkg_resources.require(modname)[0]
+pkg = pkg_resources.require(project)[0]
 pkg_name = pkg.get_metadata('top_level.txt').strip()
 
 # Simplify things by using the installed version
-version = pkg_resources.require(modname)[0].version
+version = pkg.version
 release = version
 
 # ======================== General configuration ============================

sphinx_github_style/__init__.py

@@ -3,32 +3,25 @@
 import sphinx
 import inspect
 import subprocess
-import pkg_resources
 from pathlib import Path
 from sphinx.application import Sphinx
 from sphinx.errors import ExtensionError
 from typing import Dict, Any, Optional, Callable
 
 
-__version__ = "0.0.1b16"
+__version__ = "1.0.1b0"
 __author__ = 'Adam Korn <hello@dailykitten.net>'
 
-
 from .add_linkcode_class import add_linkcode_node_class
 from .meth_lexer import TDKMethLexer
 from .github_style import TDKStyle
 
 
 def setup(app: Sphinx) -> Dict[str, Any]:
-    modpath = os.path.abspath('../')
-    modname = os.path.basename(modpath)
-    pkg = pkg_resources.require(modname)[0]
-    pkg_name = pkg.get_metadata('top_level.txt').strip()
-
     app.connect("builder-inited", add_static_path)
 
-    app.add_config_value('pkg_name', pkg_name, 'html')
     app.add_config_value('linkcode_blob', 'head', True)
+    app.add_config_value('pkg_name', None, '')
 
     app.setup_extension('sphinx_github_style.add_linkcode_class')
     app.setup_extension('sphinx_github_style.github_style')
@@ -47,9 +40,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
             "Function `linkcode_resolve` not found in ``conf.py``; "
             "using default function from ``sphinx_github_style``"
         )
-        linkcode_func = get_linkcode_resolve(
-            linkcode_url, pkg_name, modpath
-        )
+        linkcode_func = get_linkcode_resolve(linkcode_url)
 
     app.config.linkcode_resolve = linkcode_func
     return {'version': sphinx.__display_version__, 'parallel_read_safe': True}
@@ -150,7 +141,7 @@ def get_linkcode_url(app: Sphinx) -> str:
     return url
 
 
-def get_linkcode_resolve(linkcode_url: str, pkg_name: str, modpath: str) -> Callable:
+def get_linkcode_resolve(linkcode_url: str) -> Callable:
     """Defines and returns a ``linkcode_resolve`` function for your package
 
     Used by default if ``linkcode_resolve`` isn't defined in ``conf.py``
@@ -177,11 +168,15 @@ def linkcode_resolve(domain, info):
         for part in fullname.split('.'):
             try:
                 obj = getattr(obj, part)
-            except Exception:
+            except AttributeError:
                 return None
 
+        pkg_name = modname.split('.')[0]
+        pkg_dir = sys.modules.get(pkg_name).__file__
+        repo_dir = Path(pkg_dir).parent.parent
+
         try:
-            filepath = os.path.relpath(inspect.getsourcefile(obj), modpath)
+            filepath = os.path.relpath(inspect.getsourcefile(obj), repo_dir)
             if filepath is None:
                 return
         except Exception:
@@ -190,7 +185,6 @@ def linkcode_resolve(domain, info):
         try:
             source, lineno = inspect.getsourcelines(obj)
         except OSError:
-            print(f'failed to get source lines for {obj}')
             return None
         else:
             linestart, linestop = lineno, lineno + len(source) - 1

sphinx_github_style/meth_lexer.py

@@ -1,9 +1,9 @@
-import copy
 import types
 from typing import Type
 from sphinx.application import Sphinx
 from pygments.lexers.python import NumPyLexer
 from inspect import getmembers, isfunction, ismethod, ismodule, isclass
+from sphinx.errors import ExtensionError
 
 
 def get_pkg_funcs(pkg: types.ModuleType):
@@ -44,6 +44,7 @@ def get_pkg_lexer(cls, pkg_name: str) -> Type["TDKMethLexer"]:
 
 
 def setup(app: Sphinx):
-    # Get pkg_name from conf.py; fallback to pkg_name set by __init__.py
-    pkg_name = app.config._raw_config.get('pkg_name', app.config.pkg_name)
+    pkg_name = app.config._raw_config.get("pkg_name", getattr(app.config, "pkg_name"))
+    if pkg_name is None:
+        raise ExtensionError("`pkg_name` is missing from conf.py")
     app.add_lexer('python', TDKMethLexer.get_pkg_lexer(pkg_name))