sphinx-lua 1.1.4__tar.gz → 1.1.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. {sphinx-lua-1.1.4/sphinx_lua.egg-info → sphinx_lua-1.1.6}/PKG-INFO +32 -5
  2. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/README.rst +11 -0
  3. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/setup.py +16 -5
  4. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/luadoc.py +1 -1
  5. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/renderers.py +8 -4
  6. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/class.rst +3 -1
  7. sphinx_lua-1.1.6/sphinx_lua/version.py +1 -0
  8. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6/sphinx_lua.egg-info}/PKG-INFO +32 -5
  9. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua.egg-info/SOURCES.txt +1 -0
  10. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua.egg-info/requires.txt +1 -1
  11. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/LICENSE.txt +0 -0
  12. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/MANIFEST.in +0 -0
  13. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/setup.cfg +0 -0
  14. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/__init__.py +0 -0
  15. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/directives.py +0 -0
  16. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/attribute.rst +0 -0
  17. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/classsummary.rst +0 -0
  18. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/function.rst +0 -0
  19. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/method.rst +0 -0
  20. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/module.rst +0 -0
  21. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/param_list.rst +0 -0
  22. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/type.rst +0 -0
  23. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua.egg-info/dependency_links.txt +0 -0
  24. {sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua.egg-info/top_level.txt +0 -0
{sphinx-lua-1.1.4/sphinx_lua.egg-info → sphinx_lua-1.1.6}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: sphinx-lua
3
- Version: 1.1.4
3
+ Version: 1.1.6
4
4
  Summary: Support for using Sphinx on Luadoc-documented Lua code
5
5
  Author: Eliott Dumeix
6
6
  Author-email: eliott.dumeix@gmail.com
@@ -9,12 +9,28 @@ Keywords: sphinx,documentation,docs,lua,luadoc,restructured
9
9
  Classifier: Intended Audience :: Developers
10
10
  Classifier: Natural Language :: English
11
11
  Classifier: License :: OSI Approved :: MIT License
12
- Classifier: Programming Language :: Python :: 3.5
13
- Classifier: Programming Language :: Python :: 3.6
14
- Classifier: Programming Language :: Python :: 3.7
12
+ Classifier: Programming Language :: Python :: 3.9
13
+ Classifier: Programming Language :: Python :: 3.10
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
15
16
  Classifier: Topic :: Documentation :: Sphinx
16
17
  Classifier: Topic :: Software Development :: Documentation
18
+ Requires-Python: >=3.9
17
19
  License-File: LICENSE.txt
20
+ Requires-Dist: six
21
+ Requires-Dist: Jinja2>3.0
22
+ Requires-Dist: luadoc>=1.3.1
23
+ Requires-Dist: sphinxcontrib-luadomain>=1.1.1
24
+ Dynamic: author
25
+ Dynamic: author-email
26
+ Dynamic: classifier
27
+ Dynamic: description
28
+ Dynamic: keywords
29
+ Dynamic: license
30
+ Dynamic: license-file
31
+ Dynamic: requires-dist
32
+ Dynamic: requires-python
33
+ Dynamic: summary
18
34
 
19
35
  ###############################################################################
20
36
  sphinx-lua
@@ -129,3 +145,14 @@ You can display method source code appending the flag ``show-source``:
129
145
 
130
146
  .. lua:autoclass:: pl.List
131
147
  :show-source:
148
+
149
+
150
+ Showing private members
151
+ -------------------------------------------------------------------------------
152
+
153
+ By default, private members are hidden. You can display them by using the flag ``private-members``:
154
+
155
+ .. code-block:: rst
156
+
157
+ .. lua:autoclass:: pl.List
158
+ :private-members:
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/README.rst RENAMED
@@ -111,3 +111,14 @@ You can display method source code appending the flag ``show-source``:
111
111
 
112
112
  .. lua:autoclass:: pl.List
113
113
  :show-source:
114
+
115
+
116
+ Showing private members
117
+ -------------------------------------------------------------------------------
118
+
119
+ By default, private members are hidden. You can display them by using the flag ``private-members``:
120
+
121
+ .. code-block:: rst
122
+
123
+ .. lua:autoclass:: pl.List
124
+ :private-members:
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/setup.py RENAMED
@@ -8,9 +8,18 @@ except ImportError:
8
8
  from io import open
9
9
  from setuptools import setup, find_packages
10
10
 
11
+ ver_dic = {}
12
+ version_file = open("sphinx_lua/version.py")
13
+ try:
14
+ version_file_contents = version_file.read()
15
+ finally:
16
+ version_file.close()
17
+
18
+ exec(compile(version_file_contents, "sphinx_lua/version.py", 'exec'), ver_dic)
19
+
11
20
  setup(
12
21
  name='sphinx-lua',
13
- version='1.1.4',
22
+ version=ver_dic["__version__"],
14
23
  description='Support for using Sphinx on Luadoc-documented Lua code',
15
24
  long_description=open('README.rst', 'r', encoding='utf8').read(),
16
25
  author='Eliott Dumeix',
@@ -23,18 +32,20 @@ setup(
23
32
  install_requires=[
24
33
  'six',
25
34
  'Jinja2>3.0',
26
- 'luadoc>=1.3.0',
35
+ 'luadoc>=1.3.1',
27
36
  'sphinxcontrib-luadomain>=1.1.1'
28
37
  ],
29
38
  classifiers=[
30
39
  'Intended Audience :: Developers',
31
40
  'Natural Language :: English',
32
41
  'License :: OSI Approved :: MIT License',
33
- 'Programming Language :: Python :: 3.5',
34
- 'Programming Language :: Python :: 3.6',
35
- 'Programming Language :: Python :: 3.7',
42
+ 'Programming Language :: Python :: 3.9',
43
+ 'Programming Language :: Python :: 3.10',
44
+ 'Programming Language :: Python :: 3.11',
45
+ 'Programming Language :: Python :: 3.12',
36
46
  'Topic :: Documentation :: Sphinx',
37
47
  'Topic :: Software Development :: Documentation'
38
48
  ],
49
+ python_requires='>=3.9',
39
50
  keywords=['sphinx', 'documentation', 'docs', 'lua', 'luadoc', 'restructured'],
40
51
  )
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/luadoc.py RENAMED
@@ -19,7 +19,7 @@ def run_luadoc(app):
19
19
  else:
20
20
  for root, subdirs, files in os.walk(source_dir):
21
21
  for filename in files:
22
- if filename.endswith('lua'):
22
+ if filename.endswith(('lua', 'luadoc')):
23
23
  filepath = os.path.join(root, filename)
24
24
  filenames.append(filepath)
25
25
 
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/renderers.py RENAMED
@@ -79,10 +79,14 @@ class LuaRenderer(object):
79
79
 
80
80
  def start_stop_line(doc_node, file_path):
81
81
  """ Return start stop line in the form '1-5' """
82
- file = open(os.path.join(self._app.confdir, file_path), "r")
83
- start_line = file.read(doc_node.start_char).count('\n') + 1
84
- stop_line = file.read(doc_node.stop_char - doc_node.start_char).count('\n') + 1 + start_line
85
- file.close()
82
+ file_path = os.path.join(self._app.confdir, file_path)
83
+ with open(file_path, "r") as f:
84
+ content = f.read()
85
+ total_lines = content.count('\n') + 1
86
+ start_line = content[:doc_node.start_char].count('\n') + 1
87
+ stop_line = content[:doc_node.stop_char].count('\n') + 1
88
+ # Clamp to actual file line count (avoid "out of range" with Sphinx -W)
89
+ stop_line = min(stop_line, total_lines)
86
90
  return str(start_line) + "-" + str(stop_line)
87
91
 
88
92
  # Render to RST using Jinja:
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua/templates/class.rst RENAMED
@@ -26,17 +26,19 @@
26
26
 
27
27
  {# display class field #}
28
28
  {% for field in model.fields -%}
29
+ {%- if field.visibility == "public" or 'private-members' in options %}
29
30
  {%- with type=field.type -%}
30
31
  .. lua:attribute:: {{ field.name }}: {% include "type.rst" %}
31
32
 
32
33
  {{ field.desc }}
33
34
 
34
35
  {% endwith -%}
36
+ {%- endif %}
35
37
  {%- endfor %}
36
38
 
37
39
  {# display public methods first #}
38
40
  {%- for method in model.methods -%}
39
- {%- if method.visibility == "public" %}
41
+ {%- if method.visibility == "public" or 'private-members' in options %}
40
42
  {% include "method.rst" %}
41
43
  {%- endif %}
42
44
  {%- endfor %}
sphinx_lua-1.1.6/sphinx_lua/version.py ADDED
@@ -0,0 +1 @@
1
+ __version__ = '1.1.6'
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6/sphinx_lua.egg-info}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: sphinx-lua
3
- Version: 1.1.4
3
+ Version: 1.1.6
4
4
  Summary: Support for using Sphinx on Luadoc-documented Lua code
5
5
  Author: Eliott Dumeix
6
6
  Author-email: eliott.dumeix@gmail.com
@@ -9,12 +9,28 @@ Keywords: sphinx,documentation,docs,lua,luadoc,restructured
9
9
  Classifier: Intended Audience :: Developers
10
10
  Classifier: Natural Language :: English
11
11
  Classifier: License :: OSI Approved :: MIT License
12
- Classifier: Programming Language :: Python :: 3.5
13
- Classifier: Programming Language :: Python :: 3.6
14
- Classifier: Programming Language :: Python :: 3.7
12
+ Classifier: Programming Language :: Python :: 3.9
13
+ Classifier: Programming Language :: Python :: 3.10
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
15
16
  Classifier: Topic :: Documentation :: Sphinx
16
17
  Classifier: Topic :: Software Development :: Documentation
18
+ Requires-Python: >=3.9
17
19
  License-File: LICENSE.txt
20
+ Requires-Dist: six
21
+ Requires-Dist: Jinja2>3.0
22
+ Requires-Dist: luadoc>=1.3.1
23
+ Requires-Dist: sphinxcontrib-luadomain>=1.1.1
24
+ Dynamic: author
25
+ Dynamic: author-email
26
+ Dynamic: classifier
27
+ Dynamic: description
28
+ Dynamic: keywords
29
+ Dynamic: license
30
+ Dynamic: license-file
31
+ Dynamic: requires-dist
32
+ Dynamic: requires-python
33
+ Dynamic: summary
18
34
 
19
35
  ###############################################################################
20
36
  sphinx-lua
@@ -129,3 +145,14 @@ You can display method source code appending the flag ``show-source``:
129
145
 
130
146
  .. lua:autoclass:: pl.List
131
147
  :show-source:
148
+
149
+
150
+ Showing private members
151
+ -------------------------------------------------------------------------------
152
+
153
+ By default, private members are hidden. You can display them by using the flag ``private-members``:
154
+
155
+ .. code-block:: rst
156
+
157
+ .. lua:autoclass:: pl.List
158
+ :private-members:
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua.egg-info/SOURCES.txt RENAMED
@@ -7,6 +7,7 @@ sphinx_lua/__init__.py
7
7
  sphinx_lua/directives.py
8
8
  sphinx_lua/luadoc.py
9
9
  sphinx_lua/renderers.py
10
+ sphinx_lua/version.py
10
11
  sphinx_lua.egg-info/PKG-INFO
11
12
  sphinx_lua.egg-info/SOURCES.txt
12
13
  sphinx_lua.egg-info/dependency_links.txt
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/sphinx_lua.egg-info/requires.txt RENAMED
@@ -1,4 +1,4 @@
1
1
  six
2
2
  Jinja2>3.0
3
- luadoc>=1.3.0
3
+ luadoc>=1.3.1
4
4
  sphinxcontrib-luadomain>=1.1.1
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/LICENSE.txt RENAMED
File without changes
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/MANIFEST.in RENAMED
File without changes
{sphinx-lua-1.1.4 → sphinx_lua-1.1.6}/setup.cfg RENAMED
File without changes