Skip to content

Commit

Permalink
Minor documentation build process fixes and develop dependency updates (
Browse files Browse the repository at this point in the history 
#1260)
  • Loading branch information
@ktbyers
ktbyers authored Jun 28, 2019
1 parent 525566b commit 54bcf0a
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 14 deletions.
3 changes: 2 additions & 1 deletion .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ python:
- "2.7"
- "3.5"
- "3.6"
- "3.7"
matrix:
include:
- python: 3.6
env: TOXENV=black
- python: 3.6
env: TOXENV=pylama
install:
- pip install tox==3.5.3 tox-travis==0.11
- pip install tox==3.13.1 tox-travis==0.12
script:
- tox
4 changes: 2 additions & 2 deletions docs/netmiko/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4276,7 +4276,7 @@ <h2 id="parameters">Parameters</h2>
</dl>
<h2 id="attributes">Attributes</h2>
<dl>
<dt><strong><code>connection</code></strong> :&ensp;<code>netmiko.terminal_server.TerminalServer</code></dt>
<dt><strong><code>connection</code></strong> :&ensp;<a title="netmiko.terminal_server.TerminalServerSSH" href="terminal_server/index.html#netmiko.terminal_server.TerminalServerSSH"><code>TerminalServerSSH</code></a></dt>
<dd>A basic connection to the remote SSH end.</dd>
<dt><strong><code>potential_matches</code></strong> :&ensp;<code>dict</code></dt>
<dd>Dict of (device_type, accuracy) that is populated through an interaction with the
Expand All @@ -4303,7 +4303,7 @@ <h2 id="methods">Methods</h2>

Attributes
----------
connection : netmiko.terminal_server.TerminalServer
connection : netmiko.terminal_server.TerminalServerSSH
A basic connection to the remote SSH end.
potential_matches: dict
Dict of (device_type, accuracy) that is populated through an interaction with the
Expand Down
6 changes: 3 additions & 3 deletions docs/netmiko/ssh_autodetect.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ <h1 id="netmiko-connection-creation-section">Netmiko connection creation section

Attributes
----------
connection : netmiko.terminal_server.TerminalServer
connection : netmiko.terminal_server.TerminalServerSSH
A basic connection to the remote SSH end.
potential_matches: dict
Dict of (device_type, accuracy) that is populated through an interaction with the
Expand Down Expand Up @@ -427,7 +427,7 @@ <h2 id="parameters">Parameters</h2>
</dl>
<h2 id="attributes">Attributes</h2>
<dl>
<dt><strong><code>connection</code></strong> :&ensp;<code>netmiko.terminal_server.TerminalServer</code></dt>
<dt><strong><code>connection</code></strong> :&ensp;<a title="netmiko.terminal_server.TerminalServerSSH" href="terminal_server/index.html#netmiko.terminal_server.TerminalServerSSH"><code>TerminalServerSSH</code></a></dt>
<dd>A basic connection to the remote SSH end.</dd>
<dt><strong><code>potential_matches</code></strong> :&ensp;<code>dict</code></dt>
<dd>Dict of (device_type, accuracy) that is populated through an interaction with the
Expand All @@ -454,7 +454,7 @@ <h2 id="methods">Methods</h2>

Attributes
----------
connection : netmiko.terminal_server.TerminalServer
connection : netmiko.terminal_server.TerminalServerSSH
A basic connection to the remote SSH end.
potential_matches: dict
Dict of (device_type, accuracy) that is populated through an interaction with the
Expand Down
2 changes: 1 addition & 1 deletion netmiko/ssh_autodetect.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ class SSHDetect(object):
Attributes
----------
connection : netmiko.terminal_server.TerminalServer
connection : netmiko.terminal_server.TerminalServerSSH
A basic connection to the remote SSH end.
potential_matches: dict
Dict of (device_type, accuracy) that is populated through an interaction with the
Expand Down
4 changes: 3 additions & 1 deletion release_process.txt
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@

# Use pynetcio machine

# Run the following command to update docs: `pdoc3 --html --output-dir docs netmiko`
# Run the following command to update docs:
$ pdoc3 --html --output-dir docs netmiko --force

This comment has been minimized.

Sign in to view

Copy link
@kernc

kernc Jul 2, 2019

pdoc creates an additional 'namespace' directory for each documented module. Thus, the resulting directory hosting HTML files is ./docs/netmiko (whereas GitHub expects HTMLs in ./docs/ directly), and this is why the API reference URL doesn't work.

See also pdoc3/pdoc#55.

This comment has been minimized.

Sign in to view

Copy link
@ktbyers

ktbyers Jul 3, 2019

Author Owner

@carlniger I will leave this to you.

Note, we haven't published this to master branch yet. So we aren't expecting this to work right now.

This comment has been minimized.

Sign in to view

Copy link
@carlmontanari

carlmontanari Jul 3, 2019

Contributor

Once merged I think the plan is to setup Github Pages to "point" to root directory of master branch. In this case it will render the README.md... then we just link to the docs. This is currently setup on my fork so you can see it here (root/README): https://carlniger.github.io/netmiko/ and then actual docs themselves: https://carlniger.github.io/netmiko/docs/netmiko/index.html

I'm down to just have the GitHub pages just be the docs (i.e remove the readme and setup pages to point to the docs dir) or leave as is. And just for clarity here is the setting I have selected on my fork:

image

If we want to not have the README be the "entry point" obviously we can change it to master/docs and then move everything from docs/netmiko --> docs/

This comment has been minimized.

Sign in to view

Copy link
@kernc

kernc Jul 3, 2019

The readme certainly looks a better intro! I wouldn't abolish it.
Sorry for the noise. I was just zealous to see you use pdoc3. 😅

This comment has been minimized.

Sign in to view

Copy link
@carlmontanari

carlmontanari Jul 3, 2019

Contributor

No worries at all, thanks for the extra eyes, and for pdoc3 :) it made this crazy easy to do :)!

# Docs will be hosted via GitHub Pages in the master branch...
# README.md is entry point at https://ktbyers.github.io/netmiko/ which then links to...
# https://ktbyers.github.io/netmiko/docs/netmiko/index.html for full docs
Expand Down
11 changes: 6 additions & 5 deletions requirements-dev.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
pytest==3.10.0
pylama==7.6.6
tox==3.5.3
twine==1.12.1
pysnmp
pytest==4.6.3
pylama==7.7.1
tox==3.13.1
twine==1.13.0
pysnmp==4.4.9
pdoc3==0.6.2; python_version >= '3.6'
-r requirements.txt
2 changes: 1 addition & 1 deletion tox.ini
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = py27,py35,py36
envlist = py27,py35,py36,py37

[testenv]
deps =
Expand Down

0 comments on commit 54bcf0a

Please sign in to comment.