From 3c5d1cab6eb87ec481b317a2398229e36ff7eeed Mon Sep 17 00:00:00 2001 From: Eytan Adler <63426601+eytanadler@users.noreply.github.com> Date: Tue, 2 Aug 2022 16:41:20 -0400 Subject: [PATCH] Fix docs badge and logo on index page (#17) * Fixed docs tag and added logo to docs index * Removed license and corrected doc links in README * Trying removing the hidden HTML * Trying with more space * Adding close div to bottom * I give up, changed the heading --- README.md | 12 +++--------- doc/index.rst | 10 +++++++--- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5166462..30f7f45 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://dev.azure.com/mdolab/Public/_apis/build/status/mdolab.CMPLXFOIL?repoName=mdolab%2FCMPLXFOIL&branchName=main)](https://dev.azure.com/mdolab/Public/_build/latest?definitionId=45&repoName=mdolab%2FCMPLXFOIL&branchName=main) -[![Documentation Status](https://readthedocs.com/projects/mdolab-pyxlight/badge/?version=latest&token=7a9e7987d2288b741e09686619f4cd425b1a7348ebbcca59c0d20b2ad5a003f6)](https://mdolab-pyxlight.readthedocs-hosted.com/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.com/projects/mdolab-cmplxfoil/badge/?version=latest&token=79105dee7e015d89159cb837b8f5301e6ec5fa28acb4aec0b5cb06ad1cc06f48)](https://mdolab-cmplxfoil.readthedocs-hosted.com/en/latest/?badge=latest) CMPLXFOIL is a version of Mark Drela's XFOIL code with the GUI features removed. Gradient computation is implemented with the complex-step method. @@ -14,17 +14,11 @@ Gradient computation is implemented with the complex-step method. Documentation ------------- -Please see the [documentation](https://mdolab-pyxlight.readthedocs-hosted.com/en/latest/) for installation and usage details. +Please see the [documentation](https://mdolab-cmplxfoil.readthedocs-hosted.com/en/latest/) for installation and usage details. To locally build the documentation, enter the ``doc`` folder and run ``make html`` in the command line prompt. You can then view the built documentation in the ``doc/_build/html/`` by opening ``index.html``. Citing CMPLXFOIL --------------- -If you use CMPLXFOIL, please see [this page](https://mdolab-pyxlight.readthedocs-hosted.com/en/latest/citation.html) for citation information. - -License -------- -Copyright 2021 MDO Lab - -Distributed using the GNU General Public License (GPL), version 2.0; see the LICENSE.md file for details. +If you use CMPLXFOIL, please see [this page](https://mdolab-cmplxfoil.readthedocs-hosted.com/en/latest/citation.html) for citation information. diff --git a/doc/index.rst b/doc/index.rst index d6849db..7ba9422 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,5 +1,9 @@ -CMPLXFOIL -==================================== +.. image:: assets/cmplxfoil_logo.svg + :width: 500 + :align: center + +Welcome +======= CMPLXFOIL is a version of Mark Drela's XFOIL code with the GUI features removed. Gradient computation is implemented with the complex-step method. The Python interface is designed to be used with `MACH-Aero `_ tools for optimization. @@ -32,4 +36,4 @@ Increasing the number of panels helps (CMPLXFOIL uses 284 panels by default), bu .. image:: assets/multimodality_cd.svg :width: 600 - :align: center + :align: center \ No newline at end of file